Skip to content

RELEASES.md

Latest commit

 

History

History
59 lines (39 loc) · 1.2 KB

RELEASES.md

File metadata and controls

59 lines (39 loc) · 1.2 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

Always follow the semantic versioning guidelines when releasing the application. The following generic script can be used to easily make different releases/pre-releases.

release=type preid=id npm run semver

Replace the type and id with the corresponding values.

Examples

  1. Major release - 2.0.0
release=major npm run semver
  1. Minor release - 2.1.0
release=minor npm run semver
  1. Patch release - 2.1.1
release=patch npm run semver
  1. Major Alpha release - 2.0.0-alpha.0
release=premajor preid=alpha npm run semver
  1. Release Candidate minor release - 2.1.0-rc.0
release=preminor preid=rc npm run semver
  1. Release next beta (2.0.0-beta.0 to 2.0.0-beta.1)
release=prerelease preid=beta npm run semver