Skip to content

docs: add release process instructions #16

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
spiegel-im-spiegel merged 1 commit into from
May 9, 2026
Merged

docs: add release process instructions #16

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
23 changes: 23 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,26 @@ The package should hide common `net/http` idioms and keep calling code simple.

- Keep `README.md` in sync with public API changes.
- Include practical examples for GET/POST and error handling.

## Release process

- Create release tags from `main`.
- Use semantic versioning tags in `vMAJOR.MINOR.PATCH` format.
- Ensure local repository is clean and synced before tagging.

Release steps:

1. Ensure `main` is up to date.
2. Create annotated tag:
- `git tag -a vX.Y.Z -m "Release vX.Y.Z"`
3. Push tag:
- `git push origin vX.Y.Z`
4. Create GitHub release with autogenerated notes:
- `gh release create vX.Y.Z --generate-notes`

Verification steps:

- Check tag exists:
- `git tag -l "vX.Y.Z"`
- Check release exists:
- `gh release view vX.Y.Z`
Loading