Merge pull request #49 from LucianBuzzo/codex/configure-github-actions-for-versionist

Add versionist release workflow

Author: LucianBuzzo

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Versionist Release
+
+on:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: npm install
+      - name: Run versionist
+        run: npx versionist
+      - name: Commit and tag release
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add CHANGELOG.md package.json
+          if git diff --cached --quiet; then
+            echo "No versionist changes to commit"
+            exit 0
+          fi
+          VERSION=$(node -p "require('./package.json').version")
+          git commit -m "chore(release): v$VERSION"
+          git tag -a "v$VERSION" -m "v$VERSION"
+          git push --follow-tags

README.md

@@ -109,3 +109,17 @@ The icon at the top of this file is provided by
 [svgrepo.com](https://www.svgrepo.com/svg/293783/architecture-blueprint) and is
 licensed under [Creative Commons BY
 4.0](https://creativecommons.org/licenses/by/4.0/).
+
+## Contributing
+
+This project uses [Versionist](https://github.com/balena-io/versionist) to maintain the changelog and version numbers. Each commit must include a footer specifying the semantic version change and a changelog entry:
+
+```
+docs: improve README
+
+Change-Type: patch
+Changelog-Entry: Improve README documentation
+Signed-off-by: Your Name <you@example.com>
+```
+
+The `Change-Type` can be `major`, `minor` or `patch`. `Changelog-Entry` is a short description of the change. Releases are automatically created when changes land on the `master` branch.

package.json

@@ -41,7 +41,8 @@
     "stryker": "^0.33.1",
     "stryker-api": "^0.22.0",
     "stryker-html-reporter": "^0.16.9",
-    "stryker-javascript-mutator": "^0.12.1"
+    "stryker-javascript-mutator": "^0.12.1",
+    "versionist": "^8.0.0"
   },
   "ava": {
     "files": [

versionist.conf.js

@@ -0,0 +1,22 @@
+'use strict'
+
+module.exports = {
+  subjectParser: 'angular',
+  updateVersion: 'package.json',
+  addEntryToChangelog: 'prepend',
+  includeCommitWhen: commit => commit.footer['Changelog-Entry'],
+  getIncrementLevelFromCommit: commit => commit.footer['Change-Type'],
+  changelogFile: 'CHANGELOG.md',
+  template: [
+    '## v{{version}} - {{date}}',
+    '',
+    '{{#each commits}}',
+    '{{#with footer}}',
+    '* {{capitalize Changelog-Entry}}',
+    '{{/with}}',
+    '{{/each}}',
+    ''
+  ].join('\n'),
+  header:
+    '# Change Log\n\nAll notable changes to this project will be documented in this file automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!\nThis project adheres to [Semantic Versioning](http://semver.org/).\n\n'
+}