Skip to content

docs: add release process documentation#490

Merged
tomasaschan merged 1 commit into
spf13:masterfrom
happysnaker:docs-release-process
Jul 3, 2026
Merged

docs: add release process documentation#490
tomasaschan merged 1 commit into
spf13:masterfrom
happysnaker:docs-release-process

Conversation

@happysnaker

Copy link
Copy Markdown

Summary

Closes #434

Adds a RELEASING.md that documents the step-by-step release process for pflag maintainers. The current process relies on institutional knowledge that is easy to forget (as noted in #434).

Content

  • Prerequisites (write access, GitHub CLI)
  • Step-by-step instructions: pull latest, pick version, tag, create release with auto-generated notes
  • Notes on --generate-notes vs manual release notes

@tomasaschan tomasaschan left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the few releases I've shipped, I've used the UI instead of the GH CLI. That has the advantage that you can open the release notes in draft mode even before choosing a tag, and the tag gets published at the same time as the release. Since the PR list in the release notes is a good indicator for which release number (minor or patch) should be tagged, it's useful to have it available before picking a number.

The fact that the UI doesn't create the tag until the release is published is also useful to ensure we don't have tags without releases published, or need to move tags.

Reflects the maintainer's preferred workflow using the GitHub UI
for drafting releases, which publishes the tag atomically with the
release and shows the PR list before picking a version number.

Closes spf13#434
@happysnaker happysnaker force-pushed the docs-release-process branch from 49ed2e7 to 9ba8488 Compare July 3, 2026 12:40
@happysnaker

Copy link
Copy Markdown
Author

Thanks for the feedback! I've updated RELEASING.md to document the GitHub UI workflow as the recommended method first, with the GH CLI as an alternative. The UI approach is now listed as Method 1 since it has the advantages you mentioned (atomic tag+release, PR list before version pick).

@tomasaschan tomasaschan merged commit 5fdac2d into spf13:master Jul 3, 2026
8 checks passed
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.

Document release process

2 participants