Skip to content

Commit

Permalink
Add release checklist (#163)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk authored Aug 25, 2024
1 parent 2885ffa commit 14de8c2
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Release Checklist

- [ ] Update the
[`CHANGELOG.rst`](https://github.com/ofek/pypinfo/blob/master/CHANGELOG.rst)
and the version in
[`pypinfo/__init__.py`](https://github.com/ofek/pypinfo/blob/master/pypinfo/__init__.py)

- [ ] Get `master` to the appropriate code release state.
[GitHub Actions](https://github.com/ofek/pypinfo/actions) should be running
cleanly for all merges to `master`.
[![GitHub Actions status](https://github.com/ofek/pypinfo/actions/workflows/test.yml/badge.svg)](https://github.com/ofek/pypinfo/actions/)

- [ ] Create and push a tag, for example:

```bash
git tag -m 23.0.0 23.0.0
git push --tags
```

- [ ] Check the tagged
[GitHub Actions build](https://github.com/ofek/pypinfo/actions/workflows/deploy.yml)
has deployed to [PyPI](https://pypi.org/project/pypinfo/#history)

- [ ] Check installation:

```bash
pip3 uninstall -y pypinfo && pip3 install -U pypinfo && pypinfo --version
```

0 comments on commit 14de8c2

Please sign in to comment.