Debian Codegraph @

scripts/release-checklist

raw
1 Release checklist
2 =================
3
4 * Check ``git status``
5 * Check all lexers have ``versionadded:: `` set correctly.
6 * ``tox``
7 * ``tox -e check``
8 * LATER when configured properly: ``tox -e pylint``
9 * Update version in ``pygments/__init__.py`` (we use ``X.Y.Z``, so a new major release would be ``3.0.0``)
10 * Check pyproject.toml metadata: long description, trove classifiers
11 * Update release date/code name in ``CHANGES``
12 * ``git commit``
13 * Wait for the CI to finish
14 * ``git clean -xdf`` (warning: removes all untracked and ignored files,
15 do a dry run with ``git clean -xdfn`` first)
16 * ``python3 -m build``
17 * Check the size of the generated packages. If they're significantly different from the last release, check if the repository is in a modified state and that ``git clean`` was run.
18 * ``twine upload --repository test-pygments dist/*`` (``dist`` must only contain the current files given we used ``git clean -xdf``)
19 * Check Test-PyPI release page for obvious errors (like different file sizes!)
20 * ``twine upload --repository pygments dist/*``
21 * ``git tag -a $NEWVER``, i.e. ``git tag -a 1.0.0``. The message is "$NEWVER release".
22 * Add new ``CHANGES`` heading for next version
23 * ``git commit``
24 * ``git push``, ``git push --tags``
25 * Add new release on https://github.com/pygments/pygments/releases
26 * Add new milestone on https://github.com/pygments/pygments/milestones if needed
27 * Write announcement and send to mailing list/python-announce