New git branches setup

.github/branches.md

@@ -0,0 +1,30 @@
+
+main branch
+- contains latest stable release
+
+dev branch
+- latest dev version
+- branch off this to make feature X, then PR back in
+
+1 branch per release (aka release branches)
+- note that these are for preparing a release, not making a deployment
+- these are created by branching off the dev branch, e.g. release/0.3.45
+- do all the testing here, e.g. staging, etc
+- when sufficiently tested, merge branch into main
+
+on merge of release/x.y.z into main
+- after merging to main, create a tag for that version on main branch
+- delete the release branch - we don't need it anymore. Releases should be managed via tags due to immutability (e.g.   a branch could be pushed to in the future, whcih wouldn't make sense for a release of 0.3.45 to be mutated after being released to npm, dockerhub, etc, whereas a tag is just as-is, can't be updated)
+- deploy to dockerhub, npm, etc
+- merge main into dev branch to bring across version bumps for the release (and any other release based changes, e.g. changelog, etc)
+
+pros:
+- main contains the latest stable code, so easy to work with for newcomers (we don't have this currently as main is the bleeding edge code)
+- merging a release branch into main is a great place to do the tagging of releases (e.g. release 0.3.45), i.e. main just becomes a log of release/a.b.c then release/d.e.f, etc, etc
+- staging in the release branch
+- release branches allow us a gap to prep a release, i.e. build it, make a contract / staging env, run some automated or manual tests, etc. It's essentially saying "take dev branch in this state and prep a release". The prep can be tweaking the dev code if need be to making it release worthy, but only changes required for releasing, we shouldn't be doing dev on release branches
+- hotfixes are easy, branch off main, make the fix, do a release branch, pr back into main, then the hotfix will get pushed to dev too
+
+cons:
+- more branches so more discipline needed by us to not f it up (though I think the above plan is pretty simple, we can do it)
+- two big branches (main and dev) compared to our current process of 1

.github/workflows/auto_merge.yml

@@ -1,15 +1,21 @@
+# Merge a PR automatically when opened or reopened
+
 name: auto_merge
 
 on:
     pull_request:
-        branches: [main]
         types:
             - opened
             - reopened
 
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
 jobs:
     auto_merge:
         runs-on: ubuntu-latest
+        if: github.event.pull_request.draft == false
         steps:
             - name: Print contexts
               env:
@@ -53,7 +59,9 @@ jobs:
             - uses: actions/setup-node@v3
               with:
                   node-version-file: '.nvmrc'
-            - run: npm i -g npm@$(cat package.json | jq -r .engines.npm)
+
+            - name: Install
+              run: npm i -g npm@$(cat package.json | jq -r .engines.npm)
 
             - name: Enable auto-merge on PR
               env:

.github/workflows/bump_version.yml

@@ -1,3 +1,5 @@
+# Workflow which bumps the version of all packages in the repo
+
 name: bump_version
 
 on:
@@ -57,51 +59,25 @@ jobs:
 
             - uses: actions/checkout@v3
 
-            - run: mkdir -p protocol/cargo-cache
-            - run: mkdir -p protocol/target
-            - run: mkdir -p node_modules
-            - run: mkdir -p ~/.cache/Cypress
-
-            - name: Restore cache
-              uses: actions/cache/restore@v3
-              with:
-                  path: |
-                      protocol/cargo-cache
-                      protocol/target
-                      node_modules
-                      ~/.cache/Cypress
-                  # note that restoring a cache in github is a pain. The trailing '-' matches any string after the '-', therefore 'abc-' would match a cache named 'abc-1234' or 'abc-5678', etc.
-                  # the problem is 'abc-' will not match a cache named 'abc'! So if you're using wildcard cache name selectors like this, you need a field that changes as the suffix to become the wildcard
-                  # here we're setting the key to an unused cache key so it falls back to the wildcard selector in `restore-keys`
-                  key: some-unused-cache-key
-                  restore-keys: |
-                      project-cache-${{ runner.os }}-${{ runner.arch }}-
-
-            - run: ls -la ~/.cache/Cypress || true
-            - run: ls -la protocol/cargo-cache || true
-            - run: ls -la protocol/target/ink || true
-            - run: ls -la node_modules || true
-
-            - uses: actions/setup-node@v3
-              with:
-                  node-version-file: '.nvmrc'
-            - run: npm i -g npm@$(cat package.json | jq -r .engines.npm)
-
-            - run: npm ci
-
-            - run: npm run build -w @prosopo/scripts
-            - run: npm run build -w @prosopo/protocol-dev
-
             - name: Bump version
               env:
                   GITHUB_TOKEN: ${{ secrets.PROSOPONATOR_PAT }}
               run: |
+                set -euxo pipefail # stop on errors, print commands, fail on pipe fails
+
                   # make a new branch for the version changes
-                  git switch -c bump-version-${{ github.event.inputs.version }}
-
-                  # make the version changes
-                  npm run version ${{ github.event.inputs.version }}
-
+                  git switch -c release/${{ github.event.inputs.version }}
+
+                  # find all package.json files, recursively
+                  pkgJsons=$(find . -name package.json -prune -not -path '*/node_modules/*' -not -path '*/.next/*')
+                  # replace the version in all package.json files
+                  xargs -I % sh -c "cat % | jq '.version = \"${{ github.event.inputs.version }}\"' > %.new && mv %.new %" <<< "$pkgJsons"
+
+                  # find all Cargo.toml files
+                  cargoTomls=$(find . -name Cargo.toml -prune -not -path '*/protocol/cargo-cache/*')
+                  # replace the first version line in all Cargo.toml files
+                  xargs -I % sh -c "sed -i '0,/version =/s/version =.*/version = \"${{ github.event.inputs.version }}\"/' %" <<< "$cargoTomls"
+
                   # rebuild typechain
                   npm run build:typechain
 

.github/workflows/post_pr.yml → .github/workflows/cache.yml

@@ -1,11 +1,10 @@
-name: post_pr
+# Build a cache of build artifacts after PRs to speed up subsequent builds
+
+name: cache
 
-# on push to main, or manually triggered
-# we do this because any branch can use caches built on main, whereas caches built on other branches are only available to that branch and its children
 on:
     push:
-        branches:
-            - 'main'
+        branches: [main, dev]
     workflow_dispatch:
 
 concurrency:
@@ -60,6 +59,7 @@ jobs:
 
             - uses: actions/checkout@v3
 
+            # make cache dirs
             - run: mkdir -p protocol/cargo-cache
             - run: mkdir -p protocol/target
             - run: mkdir -p node_modules
@@ -103,20 +103,21 @@ jobs:
                       protocol/target
                       node_modules
                       ~/.cache/Cypress
-                  key: project-cache-${{ runner.os }}-${{ runner.arch }}-${{ github.run_id }}-${{ github.run_attempt }}
+                  key: project-cache-${{ github.event.pull_request.head.ref || github.ref }}-${{ runner.os }}-${{ runner.arch }}-${{ github.run_id }}-${{ github.run_attempt }}
 
             # remove all but the latest cache, leaving only the cache we just saved
             - name: Cleanup caches
               if: always()
               run: |
+                set -euxo pipefail # stop on errors, print commands, fail on pipe fails
+
                   set +e; gh extension install actions/gh-actions-cache; set -e
-                  REPO=${{ github.repository }}
                   echo "Fetching list of cache key"
-                  cacheKeys=$(gh actions-cache list --sort created-at --order desc --limit 100 -R $REPO --key project-cache-${{ runner.os }}-${{ runner.arch }}- | cut -f 1 | tail -n +3)
+                  cacheKeys=$(gh actions-cache list --sort created-at --order desc --limit 100 -R ${{ github.repository }} --key project-cache-${{ github.event.pull_request.head.ref || github.ref }}-${{ runner.os }}-${{ runner.arch }}- | cut -f 1 | tail -n +3)
                   echo caches to be removed:
                   echo ${cacheKeys}
                   set +e
                   for cacheKey in $cacheKeys
                   do
-                      gh actions-cache delete $cacheKey -R $REPO --confirm
+                      gh actions-cache delete $cacheKey -R ${{ github.repository }} --confirm
                   done

.github/workflows/check_version_bump.yml

@@ -0,0 +1,99 @@
+# Check the version has been bumped before releasing
+
+name: check_version_bump
+
+on:
+    pull_request:
+        branches: [main]
+    workflow_dispatch:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    check:
+        runs-on: ubuntu-latest
+        if: github.event.pull_request.draft == false
+        steps:
+            - name: Print contexts
+              env:
+                  GITHUB_CONTEXT: ${{ toJson(github) }}
+                  ENV_CONTEXT: ${{ toJson(env) }}
+                  VARS_CONTEXT: ${{ toJson(vars) }}
+                  JOB_CONTEXT: ${{ toJson(job) }}
+                  STEPS_CONTEXT: ${{ toJson(steps) }}
+                  RUNNER_CONTEXT: ${{ toJson(runner) }}
+                  SECRETS_CONTEXT: ${{ toJson(secrets) }}
+                  STRATEGY_CONTEXT: ${{ toJson(strategy) }}
+                  MATRIX_CONTEXT: ${{ toJson(matrix) }}
+                  NEEDS_CONTEXT: ${{ toJson(needs) }}
+                  INPUTS_CONTEXT: ${{ toJson(inputs) }}
+              run: |
+                  echo "******************************"
+                  echo "github:" "$GITHUB_CONTEXT"
+                  echo "******************************"
+                  echo "env:" "$ENV_CONTEXT"
+                  echo "******************************"
+                  echo "vars:" "$VARS_CONTEXT"
+                  echo "******************************"
+                  echo "job:" "$JOB_CONTEXT"
+                  echo "******************************"
+                  echo "steps:" "$STEPS_CONTEXT"
+                  echo "******************************"
+                  echo "runner:" "$RUNNER_CONTEXT"
+                  echo "******************************"
+                  echo "secrets:" "$SECRETS_CONTEXT"
+                  echo "******************************"
+                  echo "strategy:" "$STRATEGY_CONTEXT"
+                  echo "******************************"
+                  echo "matrix:" "$MATRIX_CONTEXT"
+                  echo "******************************"
+                  echo "needs:" "$NEEDS_CONTEXT"
+                  echo "******************************"
+                  echo "inputs:" "$INPUTS_CONTEXT"
+                  echo "******************************"
+
+            - uses: actions/checkout@v3
+
+            # fail-fast step to check if the version has been bumped
+            # when running manually, there won't be a version line change, so we need to skip this step in that case
+            - name: Detect version bump
+              run: |
+                set -euxo pipefail # stop on errors, print commands, fail on pipe fails
+
+
+                # get the next version as the version currently set in the root package.json
+                NEXT=$(jq -r '.version' package.json)
+                echo "Next version: $NEXT"
+
+                # checkout the repo back to before this pr
+                git checkout ${{ github.event.before }}
+
+                # get the previous version as the version currently set in the root package.json in the before state
+                PREV=$(jq -r '.version' package.json)
+                echo "Previous version: $PREV"
+
+                # switch back to the current state
+                git switch -
+
+                # break next and previous versions into major, minor, patch
+                NEXT_MAJOR=$(echo $NEXT | cut -d. -f1)
+                NEXT_MINOR=$(echo $NEXT | cut -d. -f2)
+                NEXT_PATCH=$(echo $NEXT | cut -d. -f3)
+                PREV_MAJOR=$(echo $PREV | cut -d. -f1)
+                PREV_MINOR=$(echo $PREV | cut -d. -f2)
+                PREV_PATCH=$(echo $PREV | cut -d. -f3)
+
+                # compare the versions, checking for an *increasing* version
+
+                if [[ $NEXT_MAJOR -gt $PREV_MAJOR ]]; then
+                    echo "Major version bump"
+                elif [[ $NEXT_MAJOR -eq $PREV_MAJOR && $NEXT_MINOR -gt $PREV_MINOR ]]; then
+                    echo "Minor version bump"
+                elif [[ $NEXT_MAJOR -eq $PREV_MAJOR && $NEXT_MINOR -eq $PREV_MINOR && $NEXT_PATCH -gt $PREV_PATCH ]]; then
+                    echo "Patch version bump"
+                else
+                    echo "Version not bumped / not an increasing version"
+                    exit 1
+                fi

.github/workflows/consistent_versions.yml → .github/workflows/consistent_engine_node.yml

@@ -1,11 +1,13 @@
-name: consistent_versions
+# Check the node versions are consistent across packages
+
+name: consistent_engine_node
 
 on:
     pull_request:
-        branches: [main]
+        branches: [main, dev, release/*]
         paths:
             - '**/package.json'
-            - 'package.json'
+            - '.github/workflows/consistent_engine_node.yml'
     workflow_dispatch:
 
 concurrency:
@@ -20,6 +22,7 @@ env:
 jobs:
     check:
         runs-on: ubuntu-latest
+        if: github.event.pull_request.draft == false
         steps:
             - name: Print contexts
               env:
@@ -61,22 +64,19 @@ jobs:
 
             - uses: actions/checkout@v3
 
-            - name: Check versions are consistent amongst packages
+            - name: Check contract version matches provider version
               run: |
-                  # for each package, get the version then filter to unique versions
-                  versions=$(npx --workspaces npm pkg get version | grep "@" | awk '{print $2}' | uniq)
-                  # if more than one version is detected, fail
-                  if [ $(echo "$versions" | wc -l) -gt 1 ]; then
-                      echo "Versions are not consistent amongst packages:"
-                      echo "$versions"
-                      exit 1
-                  fi
-                  # if version doesn't match the root workspace version, fail
-                  root_version=$(npm pkg get version)
-                  if [ "$versions" != "$root_version" ]; then
-                      echo "Version is not consistent with root workspace version:"
+                set -euxo pipefail # stop on errors, print commands, fail on pipe fails
+
+                  # find all package.json files, recursively
+                  pkgJsons=$(find . -name package.json -prune -not -path '*/node_modules/*' -not -path '*/.next/*')
+
+                  # extract the node version from the package.json files
+                    versions=$(jq -r '.engines.node' $pkgJsons)
+
+                    # ensure all node versions are the same
+                    if [ $(echo "$versions" | uniq | wc -l) -ne 1 ]; then
+                      echo "Node versions are not consistent across packages"
                       echo "$versions"
-                      echo "$root_version"
                       exit 1
-                  fi
-                  # else versions are consistent, pass
+                    fi