chore: Add experimental publish (#105) (#111)

Add experimental publish

Signed-off-by: Todd Baert <[email protected]>

Author: toddbaert

.github/workflows/coverage.yml

@@ -0,0 +1,27 @@
+# Generates baseline code coverage
+
+name: coverage
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install
+        run: npm ci
+
+      - name: Test
+        run: npm run test
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3

.github/workflows/experimental-release.yaml

@@ -0,0 +1,34 @@
+# Publishes a experimental version if a PR comment includes "/publish".
+
+name: publish-experimental
+
+on:
+  issue_comment:
+    types:
+      - created
+
+jobs:
+  publish-experimental:
+    if: ${{ github.event.issue.pull_request && contains(github.event.comment.body, '/publish') }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      # create an experimental version at this SHA (vX.X.X-experimental-4742ef14cc0ea07e3569eee56899937452a55a9c)
+      - name: Version
+        run: npm version "$(npm run current-version -s)-experimental-$GITHUB_SHA" --no-git-tag-version
+
+      - name: Publish
+        run: npm publish --tag experimental --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/publish-experimental.yml

@@ -34,3 +34,5 @@ Run tests with `npm test`.
 ### Packaging
 
 Both ES modules and CommonJS modules are supported, so consumers can use both `require` and `import` functions to utilize this module. This is accomplished by building 2 variations of the output, under `dist/esm` and `dist/cjs`, respectively. To force resolution of the `dist/esm/**.js*` files as modules, a package json with only the context `{"type": "module"}` is included at a in a `postbuild` step. Type declarations are included at `/dist/types/`
+
+For testing purposes, you can add a comment containing "/publish" in any PR. This will publish an experimental SDK version with the git SHA appended to the version number.

README.md

@@ -9,7 +9,8 @@
     "test": "jest --verbose",
     "lint": "eslint ./",
     "postbuild": "cp ./package.esm.json ./dist/esm/package.json",
-    "build": "rm -f -R ./dist && tsc --project tsconfig.json && tsc --project tsconfig.cjs.json"
+    "build": "rm -f -R ./dist && tsc --project tsconfig.json && tsc --project tsconfig.cjs.json",
+    "current-version": "echo $npm_package_version"
   },
   "repository": {
     "type": "git",
@@ -55,4 +56,4 @@
     "typescript": "^4.6.4"
   },
   "dependencies": {}
-}
+}