docs: add installation section and version CHANGELOG post-release - #19
Merged
Conversation
- README: add a release badge; add an Installation section covering GHCR Docker images (all three languages) and prebuilt release binaries, linking to docs/reproducible-builds.md for signature/SBOM verification - CHANGELOG: retroactively version [0.2.7] (first published release) and [0.2.8] (release-pipeline fixes); fix inaccurate GoReleaser reference (release.yml is a custom gh-cli + docker/build-push-action pipeline, not GoReleaser)
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.
Problem
Now that v0.2.7 and v0.2.8 are published, the README and CHANGELOG don't reflect it:
docker-socket-policyother than building from source — no mention of the Docker images published to GHCR or the binaries/archives attached to releases.[Unreleased], and claimed a GoReleaser workflow which doesn't exist (release.ymlis a customgh release+docker/build-push-actionpipeline).Changes
README.md
img.shields.io/github/v/release/...) next to CI/Go/License.docker pull ghcr.io/chainsafe/docker-socket-policy-{go,rs,ts}:latest, noting Cosign signing + SBOMs, linking todocs/reproducible-builds.md.releases/latest/download/...(verified the Go URL resolves with200); TS uses a<version>placeholder since its filename embeds the version and would go stale under/latest/.CHANGELOG.md
[Unreleased]into[0.2.7] - 2026-08-18(first published release, all prior content) and[0.2.8] - 2026-08-18(the three release-pipeline fixes from fix: run npm ci in ts/ in release-verify gate #15/fix: install Quint in release-verify gate #16/fix: pass --repo to gh release edit in publish-release job #17), per Keep a Changelog convention. Closes the part of CHANGELOG and README polish for first release #10's original ask that wasn't done in the first docs pass.Also filed
#18 — the Rust release asset has an ambiguous filename (
docker-socket-policyinstead ofdocker-socket-policy-rs-linux-amd64); found while writing the install instructions, tracked separately since it's arelease.ymlfix, not a docs fix.Verification
curl -sIL .../releases/latest/download/docker-socket-policy-go→ 200gh api repos/.../releases/latesttag matches the badge source