-
Notifications
You must be signed in to change notification settings - Fork 66
feat: add latest-snapshot as a badge in README.md #2247
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
BrunoMiguelNogueira
wants to merge
4
commits into
eclipse-tractusx:main
Choose a base branch
from
BrunoMiguelNogueira:latest-available-snapshot-as-badge
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
fc3e41f
new behaviour implemented
BrunoMiguelNogueira f497b77
Rearrange logic location and small corrections
BrunoMiguelNogueira 9bd5f39
Added newline at the end of the yml files
BrunoMiguelNogueira d14fd9a
Add missing copyright
BrunoMiguelNogueira File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
################################################################################# | ||
# Copyright (c) 2025 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) | ||
# | ||
# See the NOTICE file(s) distributed with this work for additional | ||
# information regarding copyright ownership. | ||
# | ||
# This program and the accompanying materials are made available under the | ||
# terms of the Apache License, Version 2.0 which is available at | ||
# https://www.apache.org/licenses/LICENSE-2.0. | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
# License for the specific language governing permissions and limitations | ||
# under the License. | ||
# | ||
# SPDX-License-Identifier: Apache-2.0 | ||
################################################################################# | ||
|
||
|
||
--- | ||
name: trigger-update-badge.yml | ||
on: | ||
workflow_dispatch: | ||
inputs: | ||
version: | ||
required: true | ||
description: 'a semver string denoting the version' | ||
update-badge: | ||
type: string | ||
required: false | ||
description: 'notEmpty if is a versioned snapshot' | ||
workflow_call: | ||
inputs: | ||
version: | ||
type: string | ||
required: true | ||
description: 'a semver string denoting the version' | ||
update-badge: | ||
type: string | ||
required: false | ||
description: 'notEmpty if is a versioned snapshot' | ||
jobs: | ||
update-snapshot-badge: | ||
name: 'Update Snapshot badge in README.md' | ||
permissions: | ||
contents: write | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v5 | ||
- name: Update README badge | ||
run: | | ||
VERSION="${{ inputs.version }}" | ||
ESCAPED_VERSION="${VERSION//-/--}" | ||
UPDATE_BADGE="${{ inputs.update-badge }}" | ||
if [ -n "$UPDATE_BADGE" ]; then | ||
sed -i "s|^\[snapshot-shield\]:.*|[snapshot-shield]:https://img.shields.io/badge/latest--snapshot-$ESCAPED_VERSION-blue?style=for-the-badge|" 'README.md' | ||
fi | ||
- name: Commit changes | ||
id: commit-update-snapshot-badge | ||
shell: bash | ||
run: | | ||
git add . | ||
if git diff --cached --quiet; then | ||
echo "Not a versioned Snapshot" | ||
else | ||
git config user.name "eclipse-tractusx-bot" | ||
git config user.email "tractusx-bot@eclipse.org" | ||
git commit --message "Update snapshot badge" | ||
git push origin HEAD | ||
fi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is not the best practice, as badge changes should not create a trace in the repositories history. I found several solutions for such badges which provide the data using an api that stores the intermediate value. I think I remember, that it is possible to use an workflow artifact that is used as data, or something like that.
And please take care, that the file end with a newline, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’ve looked into it and haven’t found a way to do this without a commit or new dependencies.
Since the version is only defined within the Action:
• Static badge: We would need to commit the updated version each time (current approach).
• Dynamic badge: We would need a publicly accessible data source fed from the Action.
From what I understand, Action outputs and artifacts cannot be accessed publicly, so the version must be persisted somewhere accessible to use it for a dynamic badge.
That leads us back to the commits, and the only way this wouldn't leave a trace in tractus would be by using an external storage, which would add a dependency.
If you have any other possibility that you would like me to try and explore let me know.