Skip to content

Commit 178f9ae

Browse files
committed
Add release instructions
1 parent 601a8c5 commit 178f9ae

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

CONTRIBUTING.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,4 +147,21 @@ Run cargo flamegraph on the relevant test. E.g. to profile ``rust/tests/large.rs
147147

148148
``sudo cargo flamegraph --root --test large``
149149

150-
This will create a file called ``flamegraph.svg``, which you can open to view the flamegraph.
150+
This will create a file called ``flamegraph.svg``, which you can open to view the flamegraph.
151+
152+
Releasing to Pypi
153+
=================
154+
155+
1. Choose a new version number (based on `semver <https://semver.org/>`_).
156+
2. ``git pull origin master``
157+
3. Update ``CHANGELOG.rst`` with the new version number.
158+
4. Update the ``release`` variable in ``docs/conf.py`` with the new version number.
159+
5. Update the ``__version__`` variable in ``src/grimp/__init__.py` with the new version number.
160+
6. Update ``project.version`` in ``pyproject.toml`` with the new version number.
161+
7. ``git commit -am "Release v{new version number"``
162+
8. ``git push``
163+
9. Wait for tests to pass on CI.
164+
10. ``git tag v{new version number}``
165+
11. ``git push --tags``
166+
12. This should kick start the Github ``release`` workflow, which builds wheels and releases the
167+
project to PyPI.

0 commit comments

Comments
 (0)