Skip to content

docs: fix the README release and license badges - #544

Merged
zcsizmadia merged 1 commit into
mainfrom
docs/readme-badges
Oct 14, 2026
Merged

zcsizmadia merged 1 commit into
mainfrom
docs/readme-badges

Conversation

@zcsizmadia

Copy link
Copy Markdown
Collaborator

The README's release and license badges render as invalid on github.com.

  • What GitHub shows: fetched through GitHub's image proxy (camo), both badges show release: invalid and license: invalid.
  • What shields.io serves: fetched directly, the same URLs render fine. So camo has cached an error response. I don't know what caused the error; most likely a temporary GitHub API failure on the shields side.
  • A second problem behind it: the release badge used include_prereleases&sort=semver. Once the cache cleared it would show release: rootfs-v29.9.0-2, because the engine rootfs releases (29.x) sort above the app versions (0.x).

Changes

  • Release badge: filter=v*&sort=semver, so only app tags count, and include_prereleases is dropped. It renders release: v0.10.0. The URL change also skips the bad cache entry.
  • License badge: now static (badge/license-Apache--2.0). The license never changes, so it doesn't need a GitHub API call that can fail. It renders license: Apache-2.0.

Both new URLs were fetched from shields.io and render as stated. That GitHub shows them correctly can only be seen after merge; I'll check the rendered README then.

@zcsizmadia
zcsizmadia merged commit 316d03d into main Oct 14, 2026
5 checks passed
@zcsizmadia
zcsizmadia deleted the docs/readme-badges branch October 14, 2026 02:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant