[CI/CD] Release documentation + automated SDK release actions

.github/workflows/publish.yml

@@ -0,0 +1,257 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+    inputs:
+      build_mode:
+        description: 'Build mode: standard = same SnarkVM on testnet+mainnet; split = testnet is ahead'
+        type: choice
+        options: [standard, split]
+        required: true
+      dry_run:
+        description: 'Dry run: skip npm publish, git tag, and GitHub release'
+        type: boolean
+        default: true
+
+jobs:
+  # ── STANDARD MODE ─────────────────────────────────────────────────────────
+  # Used when testnet and mainnet are on the same SnarkVM version.
+  # Runs yarn build:all, tests, publishes all three packages, then tags.
+
+  build-standard:
+    name: Build (standard)
+    if: inputs.build_mode == 'standard'
+    runs-on: ubuntu-latest-m
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup-yarn
+      - uses: ./.github/actions/setup-rust
+
+      - name: Build
+        run: yarn build:all
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build
+          path: |
+            sdk/dist/
+            wasm/dist/
+            create-leo-app/dist/
+
+  test-standard:
+    name: Test (standard)
+    if: inputs.build_mode == 'standard'
+    needs: build-standard
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup-yarn
+      - uses: ./.github/actions/use-build
+
+      - name: Test SDK
+        run: yarn test:sdk
+
+  publish-standard:
+    name: Publish (standard)
+    if: inputs.build_mode == 'standard'
+    needs: test-standard
+    runs-on: ubuntu-latest
+    environment: production
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/setup-node@v4
+        with:
+          registry-url: https://registry.npmjs.org
+
+      - uses: ./.github/actions/use-build
+
+      - name: Read version
+        id: version
+        run: |
+          VERSION=$(node -p "require('./wasm/package.json').version")
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "tag=v$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Publish @provablehq/wasm
+        if: ${{ !inputs.dry_run }}
+        working-directory: wasm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish @provablehq/sdk
+        if: ${{ !inputs.dry_run }}
+        working-directory: sdk
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish create-leo-app
+        if: ${{ !inputs.dry_run }}
+        working-directory: create-leo-app
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Tag and release
+        if: ${{ !inputs.dry_run }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag ${{ steps.version.outputs.tag }}
+          git push origin ${{ steps.version.outputs.tag }}
+          gh release create "${{ steps.version.outputs.tag }}" --generate-notes
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Dry run summary
+        if: ${{ inputs.dry_run }}
+        run: |
+          echo "## Dry run — nothing was published" >> $GITHUB_STEP_SUMMARY
+          echo "Would have published version **${{ steps.version.outputs.version }}**:" >> $GITHUB_STEP_SUMMARY
+          echo "- \`@provablehq/wasm\`" >> $GITHUB_STEP_SUMMARY
+          echo "- \`@provablehq/sdk\`" >> $GITHUB_STEP_SUMMARY
+          echo "- \`create-leo-app\`" >> $GITHUB_STEP_SUMMARY
+          echo "- Git tag: \`${{ steps.version.outputs.tag }}\`" >> $GITHUB_STEP_SUMMARY
+
+
+  # ── SPLIT MODE ────────────────────────────────────────────────────────────
+  # Used when the testnet SnarkVM version is ahead of mainnet.
+  # Builds testnet WASM from the testnet branch, mainnet WASM from mainnet,
+  # combines them, then builds the SDK and publishes.
+
+  build-testnet-wasm:
+    name: Build testnet WASM (split)
+    if: inputs.build_mode == 'split'
+    runs-on: ubuntu-latest-m
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: testnet
+      - uses: ./.github/actions/setup-yarn
+      - uses: ./.github/actions/setup-rust
+
+      - name: Build testnet WASM
+        run: yarn build:wasm
+
+      - name: Upload testnet WASM artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: testnet-wasm
+          path: wasm/dist/testnet/
+
+  build-split:
+    name: Build (split)
+    if: inputs.build_mode == 'split'
+    needs: build-testnet-wasm
+    runs-on: ubuntu-latest-m
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup-yarn
+      - uses: ./.github/actions/setup-rust
+
+      - name: Build mainnet WASM
+        run: yarn build:wasm
+
+      - name: Download testnet WASM artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: testnet-wasm
+          path: wasm/dist/testnet/
+
+      - name: Build SDK and create-leo-app
+        run: yarn build:sdk && yarn build:create-leo-app
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build
+          path: |
+            sdk/dist/
+            wasm/dist/
+            create-leo-app/dist/
+
+  test-split:
+    name: Test (split)
+    if: inputs.build_mode == 'split'
+    needs: build-split
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup-yarn
+      - uses: ./.github/actions/use-build
+
+      - name: Test SDK
+        run: yarn test:sdk
+
+  publish-split:
+    name: Publish (split)
+    if: inputs.build_mode == 'split'
+    needs: test-split
+    runs-on: ubuntu-latest
+    environment: production
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/setup-node@v4
+        with:
+          registry-url: https://registry.npmjs.org
+
+      - uses: ./.github/actions/use-build
+
+      - name: Read version
+        id: version
+        run: |
+          VERSION=$(node -p "require('./wasm/package.json').version")
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "tag=v$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Publish @provablehq/wasm
+        if: ${{ !inputs.dry_run }}
+        working-directory: wasm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish @provablehq/sdk
+        if: ${{ !inputs.dry_run }}
+        working-directory: sdk
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish create-leo-app
+        if: ${{ !inputs.dry_run }}
+        working-directory: create-leo-app
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Tag and release
+        if: ${{ !inputs.dry_run }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag ${{ steps.version.outputs.tag }}
+          git push origin ${{ steps.version.outputs.tag }}
+          gh release create "${{ steps.version.outputs.tag }}" --generate-notes
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Dry run summary
+        if: ${{ inputs.dry_run }}
+        run: |
+          echo "## Dry run — nothing was published" >> $GITHUB_STEP_SUMMARY
+          echo "Would have published version **${{ steps.version.outputs.version }}**:" >> $GITHUB_STEP_SUMMARY
+          echo "- \`@provablehq/wasm\`" >> $GITHUB_STEP_SUMMARY
+          echo "- \`@provablehq/sdk\`" >> $GITHUB_STEP_SUMMARY
+          echo "- \`create-leo-app\`" >> $GITHUB_STEP_SUMMARY
+          echo "- Git tag: \`${{ steps.version.outputs.tag }}\`" >> $GITHUB_STEP_SUMMARY

PUBLISH.md

@@ -1,6 +1,12 @@
-## Publish instructions
+## Building the SDK for an npm release
 
-Replace `$VERSION` with the desired new version (e.g. `0.7.0`):
+
+### Building a standard release.
+When building a release in which the underlying SnarkVM version is the same for both testnet and mainnet, this build 
+flow is used.
+
+First, replace `$VERSION` with the desired new version on the mainnet branch (e.g. `0.9.18`), then use the following
+commands.
 
 ```bash
 yarn build:all
@@ -10,4 +16,46 @@ cd ../sdk && npm publish --access public
 cd ../create-leo-app & npm publish --access public
 git tag vX.X.X
 git push origin vX.X.X
+gh release create "$(git describe --tags --abbrev=0)" --generate-notes
+```
+
+### Building a release in which the SnarkVM version is ahead of testnet.
+The wasm package contains two JS binaries, one for testnet and one for mainnet. When the Aleo testnet and mainnet 
+networks are operating on the same SnarkVM binaries `yarn build:all` is the correct command to build the SDK's binaries.
+
+However, in the case where the Aleo network releases a testnet version that is ahead of mainnet, the testnet version 
+must be built separately. The following build flow is used to publish the SDK. Once all needed changes are integrated
+for Aleo testnet, this should be merged to the testnet branch of the SDK and the following build process should be
+followed.
+
+First, replace `$VERSION` with the desired new version on the mainnet and testnet branches (e.g. `0.9.18`), then use 
+the following commands.
+
+```bash
+## Create a tempdir to store the testnet wasm build.
+mkdir tmp
+## Switch to testnet.
+git switch testnet
+## Build the wasm version of testnet and store it in a tempdir.
+yarn build:wasm
+mv wasm/dist/testnet tmp/testnet
+## Switch to mainnet.
+git switch mainnet
+## Build the wasm package.
+yarn build:wasm
+## Remove the testnet build.
+rm -r wasm/dist/testnet
+## Move the previously built testnet version into the wasm/dist folder and remove the tmp folder.
+mv tmp/testnet wasm/dist/testnet
+rmdir tmp
+## Continue building the SDK and create-leo-app binaries.
+yarn build:sdk && yarn build:create-leo-app
+## Continue the previous NPM publishing flow.
+npm login
+cd wasm && npm publish --access public
+cd ../sdk && npm publish --access public
+cd ../create-leo-app & npm publish --access public
+git tag vX.X.X
+git push origin vX.X.X
+gh release create "$(git describe --tags --abbrev=0)" --generate-notes
 ```