Skip to content

Commit

Permalink
Update release docs with output data versioning
Browse files Browse the repository at this point in the history
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
  • Loading branch information
AyanSinhaMahapatra committed Sep 7, 2021
1 parent 457f782 commit 661ceea
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion docs/source/contribute/cut_new_release.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
How to cut a new release:
=========================

Update version
--------------

- Run bumpversion with major, minor or patch to bump the version in
``setup.cfg`` and ``src/scancode_config.py``
``setup.cfg`` and ``src/scancode_config.py``. Note that this is CalVer.

- If scancode output data format is changed, increment manually the major, minor or patch
to bump the version in ``src/scancode_config.py``. Note that this is SemVer.

Tag and publish
---------------

- Update the CHANGELOG.rst

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

Create Release on GitHub
------------------------

- Run ``etc/release/scancode_release.sh`` locally.

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

- publish the release on GitHub

Upload wheels to pypi and Test
------------------------------

- then build and publish the released wheel on Pypi. For this you need your own Pypi credentials
(and get authorized to publish Pypi release: ask @pombredanne) and you need to have the ``twine``
package installed and configured.
Expand Down

0 comments on commit 661ceea

Please sign in to comment.