Skip to content

Commit

Permalink
Document release flow in README.md (#164)
Browse files Browse the repository at this point in the history
* Document release flow in `README.md`

* Remove `CHANGELOG.md`

Point to GitHub Releases instead and updates PR template with
instructions

* Add note about docs

* Update instructions
  • Loading branch information
manzt authored Jan 29, 2025
1 parent e1d730b commit b96c1c4
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 156 deletions.
7 changes: 4 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Fixes #___

## Checklist

- [ ] Unit tests added or updated
- [ ] Documentation added or updated
- [ ] Updated CHANGELOG.md
- [ ] **Clear PR title** (used for generating release notes).
- Prefer using prefixes like `fix:` or `feat:` to help organize auto-generated notes.
- [ ] **Unit tests** added or updated.
- [ ] **Documentation** added or updated.
153 changes: 0 additions & 153 deletions CHANGELOG.md

This file was deleted.

22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,25 @@ left column and its corresponding action in the right column. The formatting is
clean and easy to read.

Our CI enforces formatting, linting, and tests.

## Changelog

Check the [GitHub Releases](https://github.com/higlass/higlass-python/releases) for a detailed changelog.

## Release

Releases are managed via the GitHub UI.

[Draft a new release](https://github.com/higlass/higlass-python/releases/new):

1. **Create a tag**
- Click _"Choose a tag"_, then **type a new tag** in the format `v[major].[minor].[patch]` to create it.
- _Note_: The UI is not obvious about this. You can create a tag here, not just select one. Tag creation triggers a [workflow](.github/workflows/ci.yml) to publish to PyPI.

2. **Generate release notes**
- Click _"Generate Release Notes"_ to auto-summarize changes from merged PRs.
- Edit to exclude irrelevant changes for end users (e.g., docs or CI).

3. **Document significant changes**
- Add migration steps or noteworthy updates.
- Ensure PR titles are clear and consistent.

0 comments on commit b96c1c4

Please sign in to comment.