Skip to content

Commit

Permalink
docs: update documentation about releases
Browse files Browse the repository at this point in the history
  • Loading branch information
iMichka committed Jan 22, 2021
1 parent f8d8651 commit 9a24d59
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion docs/releasing.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,36 @@
Releasing
=========

Preparation
-----------

Run `git checkout develop`.

To build a new release, modify the version number in:

``pygccxml/__init__.py``

This version number will then automatically be used to build
the documentation and by the setup.py script when building the wheels.

Do not forget to document the changes in the ``CHANGELOG.md`` file.
Run `git add . && git commit -m "Bump version major.minor.minor"`.

Do not forget to document the latest changes in the ``CHANGELOG.md`` file.

Merging and releasing
---------------------

Merge develop into master:

Run `git merge develop master`.

Tag the version (do not forget the v):

Run `git tag vmajor.minor.minor`.

Run `git push origin v2.0.0 && git push origin master`

Wait for the CI checks to run before uploading the release to pypi.

Uploading to pypi
-----------------
Expand Down

0 comments on commit 9a24d59

Please sign in to comment.