Skip to content
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

Add release checklist #163

Merged
merged 1 commit into from
Aug 25, 2024
Merged

Add release checklist #163

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
28 changes: 28 additions & 0 deletions RELEASING.md
View file
Open in desktop
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
```
Loading