Skip to content

docs: add release badge and fix BCR install version to 0.4.1 - #24

Merged
clappingmonkey merged 1 commit into
mainfrom
docs/bcr-badge-and-install-version
Jul 26, 2026
Merged

clappingmonkey merged 1 commit into
mainfrom
docs/bcr-badge-and-install-version

Conversation

@clappingmonkey

Copy link
Copy Markdown
Owner

What does this PR do?

rules_odin is now published on the Bazel Central Registry — rules_odin@0.4.1 (BCR PR bazelbuild/bazel-central-registry#9769, merged by fmeum on 2026-07-26). This updates the README to reflect first publication:

  • Add a release badge — an auto-updating github/v/release shields badge linking to the latest release, so the advertised version never goes stale.
  • Fix the install version — the Quick Start snippet pinned version = "0.1.0", a version that was never published. Corrected to the actual published version 0.4.1 (real copy-paste bug for anyone following the README).
  • Point users at the BCR — note that rules_odin is on the Bazel Central Registry and link the module page + latest release for discovering newer versions, following the convention used by peer rulesets (aspect bazel-lib, rules_go/rust/python).

Docs-only; no rule/toolchain behavior changes.

How was it tested?

  • pre-commit run --files README.md — all hooks pass (prettier made no changes; trailing-whitespace, end-of-file-fixer, typos all green).
  • Verified link/badge targets resolve: releases/latest → HTTP 302 (works); github/v/release shields badge → HTTP 200. The canonical BCR module page is still propagating (CDN lag right after merge); the badge and primary "latest release" link both target the working GitHub releases page, so no badge is broken.
  • CI (check.yaml) will verify on this PR.

Checklist

  • PR title follows conventional commit format
  • CI passes (check.yaml — lint + test matrix)
  • Tests added or updated for new/changed behavior
  • Documentation updated if user-facing (docstrings, README, CONTRIBUTING.md)
  • No breaking changes (or BREAKING CHANGE section below is filled out)

rules_odin is now published on the Bazel Central Registry (rules_odin@0.4.1,
BCR PR bazelbuild/bazel-central-registry#9769). Update the README to reflect
first publication:

- Add an auto-updating github/v/release badge linking to the latest release,
  so the advertised version never goes stale.
- Fix the Quick Start install snippet, which pinned a never-published
  version (0.1.0), to the actual published version 0.4.1.
- Note that rules_odin is on the BCR and link the module page plus the
  latest release for discovering newer versions, following the convention
  used by peer rulesets (aspect bazel-lib, rules_go/rust/python).
@clappingmonkey
clappingmonkey merged commit 2783cec into main Jul 26, 2026
14 checks passed
@clappingmonkey
clappingmonkey deleted the docs/bcr-badge-and-install-version branch July 26, 2026 23:48
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