Release checklist still hand-edits version and draft state into the docs pages

Open
#551 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
75/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
go
Domain
documentation, release

Research direction

Start with .github/ISSUE_TEMPLATE/release.yaml, especially the --artifact-version option and the manual steps at lines 27, 29, and 40, then trace the baseline-compiler compile entry point. Verify the generated docs/versions/.md, -checklist.md, and -crosswalk.md use the release version and omit the pre-release warning, and that the corresponding manual checklist items are removed.

Written by the indexing model from the issue text.

Description

🤖 WIP issue, drafted by Claude during review of #550.

#550 automates release-version and draft-state stamping for the artifacts published to grc.store. The equivalent work for the docs site is still a manual checklist item, and it is what #544/#545 had to clean up after v2026.08.28.

.github/ISSUE_TEMPLATE/release.yaml currently asks a human to:

  • line 27 — change Version: devel to the release number in docs/versions/<VERSION>.md
  • line 29 — remove the "not for production use" warning from the same file
  • line 40 — update the headers in docs/versions/<VERSION>-checklist.md and -crosswalk.md

These are the same class of staleness #550 fixes: a value that tracks devel in-repo and has to become the release version in the published output. Doing it by hand is why a release can ship with the wrong version and warning text still in place.

The compiler already takes --artifact-version (line 23 of the same template) to pin mapping-document links to the release tag, so there is an existing seam to extend rather than a new mechanism to invent.

Suggested scope: have baseline-compiler compile derive the version header and drop the pre-release warning from --artifact-version, and delete the corresponding manual steps from the release template.

Dominant language
Go
Stars
166
Forks
44
Avg merge
1d 7h
Merged PRs (30d)
13

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ossf/security-baseline

All issues in ossf/security-baseline

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.