Skip to content

Commit 9a24d59

Browse files
committed
docs: update documentation about releases
1 parent f8d8651 commit 9a24d59

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

docs/releasing.rst

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,36 @@
11
Releasing
22
=========
33

4+
Preparation
5+
-----------
6+
7+
Run `git checkout develop`.
8+
49
To build a new release, modify the version number in:
510

611
``pygccxml/__init__.py``
712

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

11-
Do not forget to document the changes in the ``CHANGELOG.md`` file.
16+
Run `git add . && git commit -m "Bump version major.minor.minor"`.
17+
18+
Do not forget to document the latest changes in the ``CHANGELOG.md`` file.
19+
20+
Merging and releasing
21+
---------------------
22+
23+
Merge develop into master:
24+
25+
Run `git merge develop master`.
26+
27+
Tag the version (do not forget the v):
28+
29+
Run `git tag vmajor.minor.minor`.
30+
31+
Run `git push origin v2.0.0 && git push origin master`
32+
33+
Wait for the CI checks to run before uploading the release to pypi.
1234

1335
Uploading to pypi
1436
-----------------

0 commit comments

Comments
 (0)