RELEASE.md

Release Guidelines

If you need to release a new version of the depreman, follow the guidelines found in this document.

Manual Releases (Discouraged)

1. Make sure that your local copy of the repository is up-to-date, sync:

   git checkout main
   git pull origin main

   Or clone:

   git clone [email protected]:ericcornelissen/depreman.git

2. Pick a new version number in accordance with Semantic Versioning. For this example we'll use 0.3.1.

3. Update the version number in the package manifest and lockfile:

   npm version --no-git-tag-version 0.3.1

   If that fails, change the value of the version field in package.json to the new version:

   -  "version": "0.3.0",
   +  "version": "0.3.1",

   and update the version number in package-lock.json using npm install (after updating package.json), which will sync the version number.

4. Update the CHANGELOG.md, manually add the following text after the ## [Unreleased] line:

   - _No changes yet_
   
   ## [0.3.1] - YYYY-MM-DD

   The date should follow the year-month-day format where single-digit months and days should be prefixed with a 0 (e.g. 2022-01-01).

5. Commit the changes to a new release branch and push using:

   git checkout -b release-$(sha1sum package.json | head -c 7)
   git add CHANGELOG.md package.json package-lock.json
   git commit --signoff --message "Version bump"
   git push origin release-$(sha1sum package.json | head -c 7)

6. Create a Pull Request to merge the release branch into main.

7. Merge the Pull Request if the changes look OK and all continuous integration checks are passing.

   NOTE: At this point, the continuous delivery automation should kick in.