RELEASING.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# Release Checklist

- [ ] Get main to the appropriate code release state.
      [GitHub Actions](https://github.com/SethMMorton/natsort/actions) must be passing:
      [![Build Status](https://github.com/SethMMorton/natsort/workflows/Tests/badge.svg)](https://github.com/SethMMorton/natsort/actions)

- [ ] Ensure that the `CHANGELOG.md` includes the changes made since last release.
      Please follow the style outlined in https://keepachangelog.com/.
      All new entries should be added into the "Unreleased" section.

- [ ] Bump the version number. Specify either "major", "minor", or "patch":

    ```bash
    tox -e bump patch
    ```

    This will take care of updating the `CHANGELOG.md` with the correct
    release information.

- [ ] Push the bumped commit:

    ```bash
    git push
    ```

- [ ] Push the tag:

    ```bash
    git push --tags
    ```

- [ ] Check that the tagged [GitHub Actions build](https://github.com/SethMMorton/natsort/actions) has
      deployed correctly to [PyPI](https://pypi.org/project/natsort/#history).

- [ ] Check installation:

    ```bash
    python -m pip uninstall -y natsort && python -m pip install -U natsort
    ```