Fix NPM deployment script

Added documentation on how release work

Author: quittle

.github/workflows/npm.yml

@@ -38,22 +38,21 @@ jobs:
             - name: NPM Install
               run: npm ci
             - name: Build and Test
-              run: npm run build && npm run package
-            # - name: Release
-            #   if: startsWith(github.ref, 'refs/tags/v')
-            #   run: npm run release
-            # - name: GitHub Release
-            #   if: startsWith(github.ref, 'refs/tags/v')
-            #   uses: ncipollo/release-action@v1
-            #   with:
-            #       artifacts: dist/layer.zip
-            #       token: ${{ secrets.GITHUB_TOKEN }}
+              run: npm run build-and-test
+            - name: Release
+              if: startsWith(github.ref, 'refs/tags/v')
+              run: npm run release
+            - name: GitHub Release
+              if: startsWith(github.ref, 'refs/tags/v')
+              uses: ncipollo/release-action@v1
+              with:
+                  artifacts: dist/layer.zip
+                  token: ${{ secrets.GITHUB_TOKEN }}
             - name: NPM Publish
               if: startsWith(github.ref, 'refs/tags/v')
               env:
                   NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
               run: |
-                  echo "$(git describe --tags --abbrev=0)"
                   npm --no-git-tag-version version "$(git describe --tags --abbrev=0)"
                   npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
                   npm publish

README.md

@@ -164,6 +164,12 @@ Other targets of interest
 -   `prettier-fix` - Automatically fixes Prettier issues
 -   `lint-fix` - Automatically fixes ESLint issues
 
+## Releases
+
+1. Push the latest change and wait for the build to pass
+1. Tag the latest commit with the version like so `git tag -a vX.Y.Z -m X.Y.Z` and push the tag
+1. The GitHub release should be created automatically as well as updating the NPM package.
+
 ## Debugging
 
 If you see `ConfigError: Missing region in config` when running the integration test suite. You need to set the AWS region you are testing against in your environment variables. Running `AWS_REGION=us-east-1 npm run integration-test` should solve the problem.