Add README.md for project documentation and update publish workflow to trigger on semantic version tags

Author: toniocodo

.github/workflows/publish.yml

@@ -2,9 +2,8 @@ name: Publish package
 
 on:
   push:
-    branches:
-      - main
-  workflow_dispatch:
+    tags:
+      - 'v*'
 
 permissions:
   contents: read
@@ -32,6 +31,15 @@ jobs:
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
+      - name: Set package version from tag
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          if ! [[ "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?(\+[0-9A-Za-z.-]+)?$ ]]; then
+            echo "Tag must be a semantic version prefixed with v (for example, v1.2.3)."
+            exit 1
+          fi
+          pnpm version "$VERSION" --no-git-tag-version
+
       - name: Build package
         run: pnpm run build
 

README.md

@@ -0,0 +1,15 @@
+# @originprotocol/squid-utils
+
+Shared utilities for Origin Protocol Subsquid projects.
+
+## Publishing
+
+Packages are published to GitHub Packages by the `Publish package` GitHub
+Actions workflow.
+
+1. Create a GitHub Release with a semantic-version tag such as `v1.2.3`.
+2. Publish the release. Creating the tag triggers the publish workflow.
+3. The workflow removes the `v` prefix, sets the package version to `1.2.3`,
+   builds the package, and publishes it to GitHub Packages.
+
+Each version can be published only once. Use a new tag for every release.