Skip to content

Commit

Permalink
Document release process
Browse files Browse the repository at this point in the history
  • Loading branch information
jarrodmillman committed Jul 1, 2023
1 parent 7b4205a commit fa56001
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Release process for `changelist`

## Introduction

Example `version`

- 1.8.dev0 # development version of 1.8 (release candidate 1)
- 1.8rc1 # 1.8 release candidate 1
- 1.8rc2.dev0 # development version of 1.8 release candidate 2
- 1.8 # 1.8 release
- 1.9.dev0 # development version of 1.9 (release candidate 1)

## Process

- Update and review `CHANGELOG.md`:

changelist scientific-python/changelist <v0.0> main --version <0.1> >> CHANGELOG.md

where <v0.0> is the last release and <0.1> is the new one.

- Update `version` in `pyproject.toml`.

- Commit changes:

git add pyproject.toml CHANGELOG.md
git commit -m 'Designate <version> release'

- Add the version number (e.g., `1.2.0`) as a tag in git:

git tag -s [-u <key-id>] v<version> -m 'signed <version> tag'

If you do not have a gpg key, use -u instead; it is important for
Debian packaging that the tags are annotated

- Push the new meta-data to github:

git push --tags origin main

where `origin` is the name of the `github.com:scientific-python/changelist`
repository

- Review the github release page:

https://github.com/scientific-python/changelist/tags

- Publish on PyPi:

git clean -fxd
pip install -U build twine wheel
python -m build --sdist --wheel
twine upload -s dist/*

- Update `version` in `pyproject.toml`.

- Commit changes:

git add pyproject.toml
git commit -m 'Bump version'
git push origin main

0 comments on commit fa56001

Please sign in to comment.