docs: shorten the status badge labels - #25
Merged
Merged
Conversation
GitHub's own actions/workflows/<file>/badge.svg ignores the markdown alt text and renders the workflow's `name:` field, so the deploy badge read "Deploy Keycloak theme to production" no matter what the link text said. Renaming the workflow would have shortened the badge at the cost of a vaguer name in the Actions tab and in run history. Routing the same status through shields.io decouples the two: the badge label is set with ?label=, while the workflow keeps its descriptive name where that name is actually useful. Badges now read: deploy: passing ci: passing deploys to: auth.civicdatalab.in Keycloak: 26.7.0 Keycloakify: v11 Adds a "deploys to" badge, which answers the question a visitor is most likely to have about a theme repository - which server this renders - and links to the realm. The version badges are muted grey so the two that carry live state are what the eye lands on.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The deploy badge read "Deploy Keycloak theme to production" — too long, and it did not change when the markdown alt text was edited to
Deployment.Why editing the alt text did not work
GitHub's
actions/workflows/<file>/badge.svgignores markdown alt text and renders the workflow'sname:field. So[]still displayed the full workflow name.The obvious fix — renaming the workflow — would shorten the badge but make the Actions tab and run history vaguer, which is where a descriptive name earns its keep.
Routing the same status through shields.io decouples them:
?label=sets the badge text, the workflow keeps its real name.What a visitor sees now
deploy: passingci: passingdeploys to: auth.civicdatalab.inKeycloak: 26.7.0Keycloakify: v11All five verified rendering live.
Two deliberate choices
Added "deploys to" — for a theme repository, which server does this render? is the first question a visitor has, and it links straight to the realm.
Version badges muted grey so the two carrying live state are what the eye lands on first.
Docs-only, so this will not trigger a deploy — the
paths-ignorefrom #24 covers**.md. That is also a live test of it.