Skip to content

Commit 661ceea

Browse files
Update release docs with output data versioning
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
1 parent 457f782 commit 661ceea

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/source/contribute/cut_new_release.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
How to cut a new release:
22
=========================
33

4+
Update version
5+
--------------
6+
47
- Run bumpversion with major, minor or patch to bump the version in
5-
``setup.cfg`` and ``src/scancode_config.py``
8+
``setup.cfg`` and ``src/scancode_config.py``. Note that this is CalVer.
9+
10+
- If scancode output data format is changed, increment manually the major, minor or patch
11+
to bump the version in ``src/scancode_config.py``. Note that this is SemVer.
12+
13+
Tag and publish
14+
---------------
615

716
- Update the CHANGELOG.rst
817

@@ -22,6 +31,9 @@ How to cut a new release:
2231
- Draft a new release in GitHub, using the previous release blurb as a base. Highlight new and
2332
noteworthy changes from the CHANGELOG.rst.
2433

34+
Create Release on GitHub
35+
------------------------
36+
2537
- Run ``etc/release/scancode_release.sh`` locally.
2638

2739
- Upload the release archives created in the ``dist/`` directory to the GitHub release page.
@@ -33,6 +45,9 @@ How to cut a new release:
3345

3446
- publish the release on GitHub
3547

48+
Upload wheels to pypi and Test
49+
------------------------------
50+
3651
- then build and publish the released wheel on Pypi. For this you need your own Pypi credentials
3752
(and get authorized to publish Pypi release: ask @pombredanne) and you need to have the ``twine``
3853
package installed and configured.

0 commit comments

Comments
 (0)