Component
Documentation
Bug Description
The Pre-Release-As: commit trailer feature was added to release-prerelease-pr.yml in commit 310c68c (PR #1565) but is not documented in either of the two mapped documentation files:
docs/architecture/workflows.md — describes release-prerelease-pr.yml only as "Pre-release companion PR management" with no mention of the trailer override capability
docs/contributing/release-process.md — documents release-please's Release-As: mechanism but has no equivalent section for the pre-release Pre-Release-As: trailer
The implementation in .github/workflows/release-prerelease-pr.yml (lines 81–87) honors a Pre-Release-As: commit trailer to override the computed pre-release version, mirroring the stable pipeline's Release-As: trailer behavior.
Expected Behavior
docs/architecture/workflows.md should document the Pre-Release-As: trailer as a version override mechanism for the release-prerelease-pr.yml workflow, alongside the existing description of that workflow.
docs/contributing/release-process.md should include a note (similar to the Release-As: documentation) explaining that maintainers can add Pre-Release-As: X.Y.Z as a commit trailer to force a specific pre-release version.
Steps to Reproduce
- Review commit
310c68c — "feat(workflows): add Pre-Release-As trailer override to pre-release w..."
- Check
.github/workflows/release-prerelease-pr.yml lines 81–87 for the implementation
- Search
docs/architecture/workflows.md and docs/contributing/release-process.md for Pre-Release-As — no results found
Additional Context
- Changed workflow file:
.github/workflows/release-prerelease-pr.yml
- Documentation files to update:
docs/architecture/workflows.md, docs/contributing/release-process.md
- The feature mirrors
release-please's Release-As: trailer, so the documentation pattern from that feature is a good reference
Generated by Documentation Update Check · ● 1.2M · ◷
Component
Documentation
Bug Description
The
Pre-Release-As:commit trailer feature was added torelease-prerelease-pr.ymlin commit310c68c(PR #1565) but is not documented in either of the two mapped documentation files:docs/architecture/workflows.md— describesrelease-prerelease-pr.ymlonly as "Pre-release companion PR management" with no mention of the trailer override capabilitydocs/contributing/release-process.md— documents release-please'sRelease-As:mechanism but has no equivalent section for the pre-releasePre-Release-As:trailerThe implementation in
.github/workflows/release-prerelease-pr.yml(lines 81–87) honors aPre-Release-As:commit trailer to override the computed pre-release version, mirroring the stable pipeline'sRelease-As:trailer behavior.Expected Behavior
docs/architecture/workflows.mdshould document thePre-Release-As:trailer as a version override mechanism for therelease-prerelease-pr.ymlworkflow, alongside the existing description of that workflow.docs/contributing/release-process.mdshould include a note (similar to theRelease-As:documentation) explaining that maintainers can addPre-Release-As: X.Y.Zas a commit trailer to force a specific pre-release version.Steps to Reproduce
310c68c— "feat(workflows): add Pre-Release-As trailer override to pre-release w...".github/workflows/release-prerelease-pr.ymllines 81–87 for the implementationdocs/architecture/workflows.mdanddocs/contributing/release-process.mdforPre-Release-As— no results foundAdditional Context
.github/workflows/release-prerelease-pr.ymldocs/architecture/workflows.md,docs/contributing/release-process.mdrelease-please'sRelease-As:trailer, so the documentation pattern from that feature is a good reference