Skip to content

Commit ed868c0

Browse files
committed
fix: add note about version to RELEASING
1 parent aa86d66 commit ed868c0

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

RELEASING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@
33
1. Determine which package you're releasing
44
2. Determine the next version, following [semantic versioning](https://semver.org/)
55
3. Create a release branch: `git checkout -b release/{package}-v{version}`
6-
4. Update that package's CHANGELOG with:
6+
4. Update that package's `pyproject.toml` with the new version
7+
5. Update that package's CHANGELOG with:
78
- A new header with the new version
89
- A new link at the bottom of the CHANGELOG for that header
9-
5. `git push -u origin`
10-
6. Once approved, merge the PR
11-
7. `git checkout main && git pull && scripts/release {package}`
12-
8. Go to the draft release href provided by the script, update that Github release with information from the CHANGELOG, and publish it
13-
9. Github actions will automatically publish a new PyPI release
10+
6. `git push -u origin`
11+
7. Once approved, merge the PR
12+
8. `git checkout main && git pull && scripts/release {package}`
13+
9. Go to the draft release href provided by the script, update that Github release with information from the CHANGELOG, and publish it
14+
10. Github actions will automatically publish a new PyPI release
1415

1516
> [!IMPORTANT]
1617
> You'll need to set up [.netrc authentication](https://pygithub.readthedocs.io/en/stable/examples/Authentication.html#netrc-authentication) to use `scripts/release`.

0 commit comments

Comments
 (0)