Skip to content

docs: add release process documentation #490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tomasaschan merged 1 commit into from
Jul 3, 2026
Merged

docs: add release process documentation #490

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Releasing pflag

This document describes how to create a new pflag release.

## Method 1: GitHub UI (recommended by maintainers)

1. Go to the [releases page](https://github.com/spf13/pflag/releases)
2. Click **"Draft a new release"**
3. Click **"Generate release notes"** — this shows the merged PRs since the last tag, which helps determine the next version (minor vs patch)
4. Choose the tag version (e.g., `v1.0.8`) — the tag will be created when the release is published
5. Review the generated notes, then publish

This method has the advantage that the tag and release are published atomically, and the PR list helps pick the right version number before tagging.

## Method 2: GitHub CLI

```bash
git checkout master
git pull origin master

# Tag and push
git tag v1.0.8
git push origin v1.0.8

# Create release with auto-generated notes
gh release create v1.0.8 --generate-notes
```

## Notes

pflag follows [Semantic Versioning](https://semver.org/). Check the [releases page](https://github.com/spf13/pflag/releases) for the latest tag.
Loading