Merge pull request #4 from J-R-Oliver/3-add-release-workflow

3 add release workflow

Author: J-R-Oliver

.github/workflows/build.yml

@@ -45,11 +45,13 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: Setup Node ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-#         cache: npm # Currently broken
+          cache: npm
       - name: Install Dependencies
         run: npm ci
       - name: ESLint

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Release
+
+on:
+  release:
+    types: [ created ]
+
+jobs:
+  npm:
+    name: npm
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Setup Git
+        run: |
+          git config --global user.name GitHub Actions
+          git config --global user.email J-R-Oliver@users.noreply.github.com
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: https://registry.npmjs.org
+      - name: Install Dependencies
+        run: npm ci
+      - name: Generate Changelog
+        run: npx standard-version --first-release
+      - name: Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Commit Changelog
+        run: git push

README.md

@@ -161,3 +161,12 @@ This job automates tasks relating to repository linting and enforcing best pract
 #### Node
 
 This job automates `Node.js` specific tasks.
+
+### Release Workflow
+
+The [release](./.github/workflows/release.yml) workflow handles release tasks. This workflow consists of one job, `npm`.
+
+#### npm
+
+This job automates tasks relating to updating [changelog](./CHANGELOG.md), tagging and publishing to (
+npm)(https://www.npmjs.com).