summaryrefslogtreecommitdiff
path: root/scripts/release-checklist
blob: fc384c0e8515fa2b353dead02de341e3f17d9f15 (plain)
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
Release checklist
=================

* Check ``git status``
* Check all lexers have ``versionadded:: `` set correctly.
* ``tox``
* ``tox -e check``
* LATER when configured properly: ``tox -e pylint``
* Update version in ``pygments/__init__.py``
* Check pyproject.toml metadata: long description, trove classifiers
* Update release date/code name in ``CHANGES``
* ``git commit``
* Wait for the CI to finish
* ``git clean -xdf`` (warning: removes all untracked and ignored files,
   do a dry run with ``git clean -xdfn`` first)
* ``python3 -m build``
* 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.
* ``twine upload dist/Pygments-$NEWVER*``
* Check PyPI release page for obvious errors (like different file sizes!)
* ``git tag -a``
* Add new ``CHANGES`` heading for next version
* ``git commit``
* ``git push``, ``git push --tags``
* Add new release on https://github.com/pygments/pygments/releases
* Add new milestone on https://github.com/pygments/pygments/milestones if needed
* Write announcement and send to mailing list/python-announce