chore: adding docs to release please (#3571)

# Description

This PR attempts to add docs to release_please

## Problem\*

So far our attempts with docs workflows have been unsuccessful. The
latest try was almost there, but it implied having a PR after the
release is merged, which would actually make the docs show up _after_
the tag, not before. So when the release was tagged as stable, it
wouldn't have the docs at that point in time.

## Summary\*

This change attempts to do some blind changes, as I tried faking master
with another branch and somehow didn't make it actually trigger new
tags.

---------

Co-authored-by: Tom French <tom@tomfren.ch>

.github/workflows/docs-pr.yml

@@ -74,12 +74,6 @@ jobs:
       - name: Install Yarn dependencies
         uses: ./.github/actions/setup
 
-      - name: Remove pre-releases
-        working-directory: docs
-        env: 
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: yarn setStable
-
       - name: Build docs
         working-directory: docs
         run: 

.github/workflows/publish-docs.yml

@@ -0,0 +1,57 @@
+name: Publish documentation
+
+on:
+  workflow_dispatch:
+    inputs:
+      noir-ref:
+        description: The noir reference to checkout
+        required: false
+        default: 'master'
+
+jobs:
+  publish-docs:
+    name: Publish docs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout release branch
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.noir-ref }}
+          token: ${{ secrets.NOIR_RELEASES_TOKEN }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+
+      - name: Install wasm-bindgen-cli
+        uses: taiki-e/install-action@v2
+        with:
+          tool: wasm-bindgen-cli@0.2.86
+
+      - name: Install wasm-opt
+        run: |
+          npm i wasm-opt -g
+      
+      - name: Install Yarn dependencies
+        uses: ./.github/actions/setup
+
+      - name: Build docs for deploying
+        working-directory: docs
+        run: 
+          yarn workspaces foreach -Rt run build
+
+      - name: Deploy to Netlify
+        uses: nwtgck/actions-netlify@v2.1
+        with:
+          publish-dir: './docs/build'
+          production-branch: master
+          production-deploy: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          enable-github-deployment: false
+          deploy-message: "Deploy from GitHub Actions for tag ${{ inputs.noir-ref }}"
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        timeout-minutes: 1

.github/workflows/release.yml

@@ -50,6 +50,42 @@ jobs:
           git commit -m 'chore: Update lockfile'
           git push
 
+  
+  update-docs:
+    name: Update docs
+    needs: [release-please, update-lockfile]
+    if: ${{ needs.release-please.outputs.release-pr }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout release branch
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ fromJSON(needs.release-please.outputs.release-pr).headBranchName }}
+          token: ${{ secrets.NOIR_RELEASES_TOKEN }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+
+      - name: Install Yarn dependencies
+        uses: ./.github/actions/setup
+
+      - name: Cut a new version
+        working-directory: ./docs
+        run: yarn docusaurus docs:version ${{ needs.release-please.outputs.tag-name }}
+
+      - name: Configure git
+        run: |
+          git config --local user.name 'signorecello'
+          git config --local user.email 'github@zepedro.me'
+
+      - name: Commit new documentation version
+        run: |
+          git add .
+          git commit -m "chore(docs): cut new docs version for tag ${{ needs.release-please.outputs.tag-name }}"
+          git push
+
   build-binaries:
     name: Build binaries
     needs: [release-please]
@@ -78,19 +114,18 @@ jobs:
           ref: master
           token: ${{ secrets.NOIR_REPO_TOKEN }}
           inputs: '{ "noir-ref": "${{ needs.release-please.outputs.tag-name }}", "npm-tag": "latest" }'
-
 
   publish-docs:
     name: Publish docs
     needs: [release-please]
     if: ${{ needs.release-please.outputs.tag-name }}
     runs-on: ubuntu-latest
+
     steps:
-      - name: Dispatch to publish workflow
+      - name: Dispatch to publish-docs
         uses: benc-uk/workflow-dispatch@v1
         with:
-          workflow: docs-new-version.yml
-          repo: noir-lang/noir
+          workflow: publish-docs.yml
           ref: master
-          token: ${{ secrets.GITHUB_TOKEN }}
-          inputs: '{ "tag": "${{ needs.release-please.outputs.tag-name }}"}'
+          token: ${{ secrets.NOIR_REPO_TOKEN }}
+          inputs: '{ "noir-ref": "${{ needs.release-please.outputs.tag-name }}" }'

docs/package.json

@@ -4,8 +4,8 @@
   "private": true,
   "scripts": {
     "start": "docusaurus start",
-    "build": "docusaurus build",
-    "setStable": "node ./scripts/setStable.js"
+    "build": "yarn version::stables && docusaurus build",
+    "version::stables": "node ./scripts/setStable.js"
   },
   "dependencies": {
     "@docusaurus/core": "^2.4.0",

release-please-config.json

@@ -48,6 +48,11 @@
           "type": "json",
           "path": "tooling/noirc_abi_wasm/package.json",
           "jsonpath": "$.version"
+        },
+        {
+          "type": "json",
+          "path": "docs/docs/package.json",
+          "jsonpath": "$.version"
         }
       ]
     },