release workflow (#7)

Author: shiyuhang0

.github/workflows/lint.yml

@@ -26,3 +26,10 @@ jobs:
             git diff
             exit 1
           fi
+      - run: |
+          npm run version
+          if [ "$(git diff | wc -l)" -gt "0" ]; then
+            echo "Check version fail, please run 'npm run version' to fix."
+            git diff
+            exit 1
+          fi    

.github/workflows/publish.yml

@@ -0,0 +1,19 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

docs/dev-guide.md

@@ -0,0 +1,5 @@
+# How to release
+
+1. Update the version in `package.json` and run `npm run version`. Then merge the PR.
+2. Publish a new GitHub release.
+3. The npm pacakge will be published automatically.

package.json

@@ -19,7 +19,7 @@
     "pretest": "npm run build",
     "test": "jest __tests__ --passWithNoTests",
     "integrationTest": "npm run build && jest integration-test --passWithNoTests",
-    "version": "echo \"export const Version = '$npm_package_version'\" > src/version.ts && git add src/version.ts && npm run build",
+    "version": "echo \"export const Version = '$npm_package_version'\" > src/version.ts",
     "prepublishOnly": "npm run build"
   },
   "prettier": {