docs: refresh post-v0.41.2 release#620
Conversation
- Bump concrete install/Docker examples (installation.md, docker.md) from v0.40.0 to v0.41.2 - Bump --version sample output (development.md) to 0.41.2 - Genericize release-process examples to vX.Y.Z placeholders in CLAUDE.md, CONTRIBUTING.md, docs/development.md, docs/release-checklist.md, and release.yml workflow_dispatch input description so they don't drift - Correct stale release-process step that instructed editing cmd/confd/version.go (version is ldflag-injected by goreleaser)
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #620 +/- ##
==========================================
- Coverage 70.96% 70.90% -0.06%
==========================================
Files 53 53
Lines 5682 5682
==========================================
- Hits 4032 4029 -3
- Misses 1422 1425 +3
Partials 228 228 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Documentation refresh following the v0.41.2 release, updating user-facing version examples across install/development docs and making release-process examples resilient by switching hardcoded tags to vX.Y.Z / vX.Y.Z-rc.N placeholders. It also aligns release instructions with the actual build/versioning approach (version injected via ldflags), removing guidance that implied manual edits to cmd/confd/version.go.
Changes:
- Bumped concrete version examples from
0.40.0→0.41.2in installation, Docker image tags, and--versionoutput snippets. - Replaced hardcoded release tag examples with
vX.Y.Z/vX.Y.Z-rc.Nplaceholders across release workflow documentation and the release workflow_dispatch input description. - Updated release-process quick references to focus on updating
CHANGELOG+ docs rather than editing a version file.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/release-checklist.md | Updates RC tagging examples to vX.Y.Z placeholders and refreshes the RC doc-update step to include docker docs. |
| docs/installation.md | Bumps pinned version examples and Dockerfile ARG to 0.41.2. |
| docs/docker.md | Updates the image tag table to v0.41.2 tags. |
| docs/development.md | Updates sample --version output and corrects the release quick reference to reflect ldflags-injected versioning + CHANGELOG/docs updates. |
| CONTRIBUTING.md | Updates a conventional commit example to use vX.Y.Z placeholder. |
| CLAUDE.md | Genericizes release/tag examples to vX.Y.Z placeholders and clarifies tag-driven version injection. |
| .github/workflows/release.yml | Updates workflow_dispatch tag input description to use vX.Y.Z / vX.Y.Z-rc.1 examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Documentation audit after v0.41.2 release. Two classes of fixes:
1. Bump concrete user-facing version examples
docs/installation.md— install URLs, RPM/DEB names, Docker tags, DockerfileARGdocs/docker.md— image-tag tabledocs/development.md—--versionsample outputAll updated from
v0.40.0→v0.41.2.2. Genericize release-process examples to
vX.Y.ZplaceholdersThe release-workflow docs hardcoded
v0.40.0/v0.40.0-rc.1ingit tag/git pushexamples. Those examples are illustrative — they don't refer to a current artifact — so pinning them to a version means they go stale every release. Switched tovX.Y.Z/vX.Y.Z-rc.Nplaceholders in:CLAUDE.mdCONTRIBUTING.mddocs/development.mddocs/release-checklist.md.github/workflows/release.yml(workflow_dispatch input description)3. Correct a wrong step
docs/development.mdand the release-process examples instructed editingcmd/confd/version.goduring a release. That file is ldflag-injected by goreleaser at build time — no manual edits required. ProjectCLAUDE.mdalready documents this; the dev-docs were just out of sync. Removed the step and updated the recipe to add CHANGELOG + installation.md instead.Audited but not changed
Test plan