Update deploy flow to be triggered by a change in version.ts

Author: sebastianquek

.github/workflows/build.yml

@@ -30,6 +30,6 @@ jobs:
         with:
           node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
-      
+
       - name: Test building of npm files
-        run: deno task npm 0.0.0
+        run: deno task npm

.github/workflows/release.yml

@@ -2,8 +2,10 @@ name: Release
 
 on:
   push:
-    tags:
-      - '*'
+    branches:
+      - master
+    paths:
+      - 'version.ts'
 
 jobs:
   release:
@@ -27,23 +29,24 @@ jobs:
         env:
           SERPAPI_TEST_KEY: ${{ secrets.SERPAPI_TEST_KEY }}
         run: deno task test:ci
-      
-      - name: Get tag version
-        if: startsWith(github.ref, 'refs/tags/')
-        id: get_tag_version
-        run: echo "TAG_VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_OUTPUT
-      
+
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
           node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
-      
+
       - name: Build npm files
-        run: deno task npm ${{ steps.get_tag_version.outputs.TAG_VERSION }}
-      
+        run: deno task npm
+
+      - name: Push tag
+        run: |
+          VERSION=$(cat version.ts | sed -n 's/.*"\(.*\)".*/\1/p')
+          echo $VERSION
+          git tag $VERSION
+          git push origin $VERSION
+
       - name: npm publish
-        if: startsWith(github.ref, 'refs/tags/')
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: cd npm && npm publish

CHANGELOG.md

@@ -14,6 +14,8 @@ and this project adheres to
 
 ### Changed
 
+- Update deploy flow to be triggered by a change in `version.ts`.
+
 ### Fixed
 
 ### Removed

CONTRIBUTING.md

@@ -96,11 +96,11 @@ SerpApi project members will then review the request.
 
 ## Release new versions
 
-1. Update changelog
+1. Update changelog.
 2. Merge the associated PR and ensure the "Build" workflow succeeds.
-3. Push a new tag based on [semantic versioning](https://semver.org/), e.g.
+3. Update `version.ts` based on [semantic versioning](https://semver.org/), e.g.
    `1.2.0`.
-4. Once the "Release" workflow succeeds, verify the new versions on npm and
-   deno.land/x.
+4. Push `version.ts`. This triggers the "Release" workflow.
+5. Verify that new versions have been released on npm and deno.land/x.
 
 [^1]: https://deno.land/manual/references/vscode_deno

scripts/build_npm.ts

@@ -1,14 +1,8 @@
 import { build, emptyDir } from "https://deno.land/x/dnt@0.32.0/mod.ts";
+import { version } from "../version.ts";
 
 await emptyDir("./npm");
 
-const version = Deno.args[0];
-if (!version) {
-  throw new Error(
-    "Specify a version as the first argument, e.g. `deno task npm 0.0.1`",
-  );
-}
-
 await build({
   entryPoints: ["./mod.ts"],
   outDir: "./npm",