Skip to content

Latest commit

 

History

History
75 lines (43 loc) · 1.77 KB

RELEASES.rst

File metadata and controls

75 lines (43 loc) · 1.77 KB
Raw

Release Instructions

This document contains all the necessary instructions to release the project and to generate the corresponding changelog.

Versioning

We follow the PEP0440 versioning standard when releasing cssi library. Please read the versioning guidelines document carefully before attempting any release related tasks.

Creating a Release

Install Changelog Generator

We have used the git-changelog package to automate the changelog generation process. Click here to learn more about git-changelog. Execute the below command to install the package on your machine.

pip install git-changelog

Using the release script

We have created a script to automate the taging and versioning of the releae pipeline. Follow the bellow guidelines when using the release script.

NOTE: Execute the release script from the root directory.

sh ./scripts/release.sh $release_type $release_level

Replace the $release_type and $release_level with the corresponding values.

Examples

  1. Major release - From 1.9 to 2.0
sh ./scripts/release.sh major final
  1. Minor release - From 1.1.x to 1.2
sh ./scripts/release.sh minor final
  1. Patch release - From 1.1.3 to 1.1.4
sh ./scripts/release.sh patch final
  1. Major Alpha release - From 1.9.2 to 1.0a0
sh ./scripts/release.sh major alpha
  1. Release next beta - From 0.1b2 to 0.1b3
sh ./scripts/release.sh prenext beta