Skip to content

Commit

Permalink
MAINT: Touchup release checklist template
Browse files Browse the repository at this point in the history
  • Loading branch information
has2k1 committed Apr 26, 2024
1 parent 9ada13f commit 740d0a7
Showing 1 changed file with 1 addition and 29 deletions.
30 changes: 1 addition & 29 deletions tools/release-checklist-tpl.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,49 +10,36 @@ Release: mizani-<VERSION>

- [ ] Run tests and coverage locally

<details>

```sh
git switch main
git pull origin/main
make test
make coverage
```

- [ ] The tests pass
- [ ] The coverage is acceptable

</details>

- [ ] The latest [online documentation](https://mizani.readthedocs.io/en/latest/) builds, be sure to browse

- [ ] Create a release branch

<details>

```sh
git switch -c release-v<VERSION>
```

</details>

- [ ] Tag a pre-release version. These are automatically deployed on `testpypi`

<details>

```sh
git tag -as v<VERSION>a1 -m "Version <VERSION>a1" # e.g. <VERSION>a1, <VERSION>b1, <VERSION>rc1
git push -u origin release-v<VERSION>
```
- [ ] GHA [release job](https://github.com/has2k1/mizani/actions/workflows/release.yml) passes
- [ ] Mizani test release is on [TestPyPi](https://test.pypi.org/project/mizani)

</details>


- [ ] Update changelog

<details>

```sh
nvim doc/changelog.rst
git commit -am "Update changelog for release"
Expand All @@ -62,12 +49,8 @@ Release: mizani-<VERSION>
- [ ] Add a release date
- [ ] The [GHA tests](https://github.com/has2k1/mizani/actions/workflows/testing.yml) pass

</details>

- [ ] Tag final version and release

<details>

```sh
git tag -as v<VERSION> -m "Version <VERSION>"
git push
Expand All @@ -76,25 +59,16 @@ Release: mizani-<VERSION>
- [ ] The [GHA Release](https://github.com/has2k1/mizani/actions/workflows/release.yml) job passes
- [ ] [PyPi](https://pypi.org/project/mizani) shows the new release

</details>

- [ ] Update `main` branch

<details>

```sh
git switch main
git merge --ff-only release-v<VERSION>
git push
```

</details>

- [ ] Create conda release

<details>


- [ ] Copy _SHA256 hash_. Click view hashes, for the [Source Distribution](https://pypi.org/project/mizani/<VERSION>/#files) (`.tar.gz`).

- [ ] Update [mizani-feedsock](https://github.com/conda-forge/mizani-feedstock)
Expand All @@ -111,6 +85,4 @@ Release: mizani-<VERSION>
- [ ] Create a [PR](https://github.com/conda-forge/mizani-feedstock/pulls)
- [ ] Complete PR (follow the steps and merge)

</details>

- [ ] Add [zenodo badge](https://doi.org/10.5281/zenodo.592370) to the changelog.

0 comments on commit 740d0a7

Please sign in to comment.