Skip to content

[docs] B: Fix Readme Badges #65

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.

Sign up for GitHub

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

Merged
csegarragonz merged 2 commits into from
Dec 6, 2025
Merged

[docs] B: Fix Readme Badges #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7b30d6
[docs] B: Fix Readme Badges
csegarragonz Dec 6, 2025
7a52596
[ci] B: Fix Release Workflow
csegarragonz Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,7 @@ on:
workflow_dispatch:

jobs:
version-badge:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: "Read version"
id: version
run: echo "VERSION=$(cat VERSION)" >> $GITHUB_ENV

- name: "Generate SVG badge"
run: |
cat > version.svg <<EOF
<svg xmlns="http://www.w3.org/2000/svg" width="140" height="20">
<rect width="60" height="20" fill="#555"/>
<rect x="60" width="80" height="20" fill="#007ec6"/>
<text x="30" y="14" fill="#fff" font-family="Verdana" font-size="11">version</text>
<text x="100" y="14" fill="#fff" font-family="Verdana" font-size="11">${VERSION}</text>
</svg>
EOF

- name: "Commit badge"
run: |
git config user.name "github-actions"
git config user.email "github-actions@github.com"
git add version.svg
git commit -m "[build] E: Update Version Badge To ${VERSION}" || echo "No changes"
git push

# Run this job strictly after updating the version badge, so that the updated
# badge makes it into the tag.
build-and-push:
needs: version-badge
runs-on: ubuntu-latest
steps:
- name: "Check out the repo"
Expand Down
19 changes: 7 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,13 @@
<strong>Access Control for Confidential Serverless</strong>
</p>

<p>
<a href="https://github.com/faasm/tless/blob/main/VERSION">
<img src="version.svg" alt="Accless Version" />
</a>
<a href="https://github.com/faasm/tless/actions/workflows/tests.yml">
<img src="https://github.com/faasm/tless/actions/workflows/tests.yml/badge.svg"
alt="Integration Tests" />
</a>
<a href="https://github.com/faasm/tless/actions/workflows/snp.yml">
<img src="https://github.com/faasm/tless/actions/workflows/snp.yml/badge.svg"
alt="SNP End-to-End Tests" />
</a>
<p style="display: flex; gap: 6px; justify-content: center; align-items: center;">
<img
src="https://img.shields.io/github/v/tag/faasm/tless?sort=semver&label=version"
alt="Accless Version"
/>
<a href="https://github.com/faasm/tless/actions/workflows/tests.yml"><img src="https://github.com/faasm/tless/actions/workflows/tests.yml/badge.svg" alt="Integration Tests" /></a>
<a href="https://github.com/faasm/tless/actions/workflows/snp.yml"><img src="https://github.com/faasm/tless/actions/workflows/snp.yml/badge.svg" alt="SNP End-to-End Tests" /></a>
</p>
Comment on lines +8 to 15
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Dec 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The new dynamic version badge is a great change! However, the updated HTML block has a couple of issues: the version badge is no longer clickable, and the formatting for the other badges has become less readable. I'd suggest wrapping the version badge in a link to the releases page and restoring the multi-line formatting for all badges to improve readability and maintainability.

Suggested change
<p style="display: flex; gap: 6px; justify-content: center; align-items: center;">
<img
src="https://img.shields.io/github/v/tag/faasm/tless?sort=semver&label=version"
alt="Accless Version"
/>
<a href="https://github.com/faasm/tless/actions/workflows/tests.yml"><img src="https://github.com/faasm/tless/actions/workflows/tests.yml/badge.svg" alt="Integration Tests" /></a>
<a href="https://github.com/faasm/tless/actions/workflows/snp.yml"><img src="https://github.com/faasm/tless/actions/workflows/snp.yml/badge.svg" alt="SNP End-to-End Tests" /></a>
</p>
<p style="display: flex; gap: 6px; justify-content: center; align-items: center;">
<a href="https://github.com/faasm/tless/releases">
<img
src="https://img.shields.io/github/v/tag/faasm/tless?sort=semver&label=version"
alt="Accless Version"
/>
</a>
<a href="https://github.com/faasm/tless/actions/workflows/tests.yml">
<img
src="https://github.com/faasm/tless/actions/workflows/tests.yml/badge.svg"
alt="Integration Tests"
/>
</a>
<a href="https://github.com/faasm/tless/actions/workflows/snp.yml">
<img
src="https://github.com/faasm/tless/actions/workflows/snp.yml/badge.svg"
alt="SNP End-to-End Tests"
/>
</a>
</p>

<hr>
</div>
Expand Down
Loading