ci(release): automate release of CLI (#2642)

* ci(release): add gh workflow to automatically create release pr

* ci(release): create workflow for releasing all packages as latest

* ci(release): remove unneeded release workflows

* ci(release): replace worker image in docker image publish

* ci(release): publish official docker image after npm publish

* ci(release): adjust which packages get auto released

* chore(ci): add name to release pr workflow

* ci(release): add permissions for create release pr at workflow level

* ci(release): add npm publish for specific pkg in case of err

Author: bernardobridge

.github/workflows/create-release-pr.yml

@@ -0,0 +1,73 @@
+name: Create Release PR
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  create_release_pr:
+    runs-on: ubuntu-latest
+    env:
+      # these are the packages we auto release (e.g. standalone pkgs like artillery/skytrace/types, and included dependencies like plugins)
+      # some non-included dependencies are not released automatically (e.g. posthog, memory-inspector)
+      # this list should be kept in sync with npm-publish-all-packages.yml
+      PACKAGES_TO_RELEASE: "\
+        artillery-engine-playwright,\
+        artillery-plugin-apdex,\
+        artillery-plugin-ensure,\
+        artillery-plugin-expect,\
+        artillery-plugin-fake-data,\
+        artillery-plugin-metrics-by-endpoint,\
+        artillery-plugin-publish-metrics,\
+        commons,\
+        core,\
+        artillery,\
+        skytrace"
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # all packages receive minor version bump, except for artillery which receives a patch version bump as convention
+      - name: Update package versions
+        run: |
+          for package in $(echo ${{ env.PACKAGES_TO_RELEASE }} | tr "," "\n"); do
+            if [ "$package" = "artillery" ]; then
+              npm version patch --workspace $package
+            else
+              npm version minor --workspace $package
+            fi
+          done
+
+      - name: Get new Artillery version
+        run: |
+          ARTILLERY_VERSION=$(node -e "console.log(require('./packages/artillery/package.json').version)")
+          echo "ARTILLERY_VERSION=$ARTILLERY_VERSION" >> "$GITHUB_ENV"
+
+      - name: Create branch
+        run: |
+          export BRANCH_NAME=release/artillery-v${{ env.ARTILLERY_VERSION }}-$(date '+%Y-%m-%d-%H-%M-%S')
+          echo "BRANCH_NAME=$BRANCH_NAME" >> "$GITHUB_ENV"
+          git checkout -b $BRANCH_NAME
+          git push --set-upstream origin $BRANCH_NAME
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Add changes to commit
+        run: git add .
+
+      - name: Commit changes
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+          RELEASE_COMMIT_MSG="ci: release v${{ env.ARTILLERY_VERSION }} artillery" >> "$GITHUB_ENV"
+          git commit -m "ci: release v${{ env.ARTILLERY_VERSION }} artillery"
+          git push
+
+      - name: create pull request
+        run: gh pr create -B main -H ${{ env.BRANCH_NAME }} --body 'Release v${{ env.ARTILLERY_VERSION }}. Created by Github action' --fill
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docker-publish-artillery.yml

@@ -1,11 +1,19 @@
 name: Publish Docker image for Artillery
 
 on:
-  push:
-    branches:
-      - main
-    paths:
-      - packages/artillery/package.json
+  workflow_call:
+    inputs:
+      COMMIT_SHA:
+        description: 'Commit SHA'
+        required: true
+        type: string
+    secrets:
+      DOCKER_USERNAME:
+        description: 'Docker Hub username'
+        required: true
+      DOCKER_PASSWORD:
+        description: 'Docker Hub password'
+        required: true
 
 jobs:
   push_to_registry:
@@ -20,6 +28,10 @@ jobs:
         run: |
           echo "ARTILLERY_VERSION=$(node -e 'console.log(require("./packages/artillery/package.json").version)')" >> $GITHUB_ENV
 
+      - run: node .github/workflows/scripts/replace-worker-version-in-js-file.js
+        env:
+          COMMIT_SHA: ${{ inputs.COMMIT_SHA }}
+
       - name: Log in to Docker Hub
         uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
         with:

.github/workflows/npm-publish-all-packages-canary.yml

@@ -11,7 +11,8 @@ on:
       - 'packages/artillery-plugin-ensure/**'
       - 'packages/artillery-plugin-expect/**'
       - 'packages/artillery-plugin-metrics-by-endpoint/**'
-      - 'packages/artillery-plugin-publish-metrics/**'      
+      - 'packages/artillery-plugin-publish-metrics/**'
+      - 'packages/artillery-plugin-fake-data/**'   
       - 'packages/commons/**'
       - 'packages/core/**'
       - 'packages/skytrace/**'

.github/workflows/npm-publish-all-packages.yml

@@ -0,0 +1,79 @@
+name: Publish packages to CLI
+on:
+  push:
+    branches:
+      - main
+    paths:
+      #If there are changes to package.json and ci:release v is in commit msg, it's a release
+      - 'packages/artillery/package.json'
+      
+jobs:
+  publish-fargate-worker-image:
+    if: "contains( github.event.head_commit.message, 'ci: release v')"
+    uses: ./.github/workflows/docker-ecs-worker-image.yml
+    permissions:
+      contents: read
+      id-token: write
+    secrets:
+      ECR_WORKER_IMAGE_PUSH_ROLE_ARN: ${{ secrets.ECR_WORKER_IMAGE_PUSH_ROLE_ARN }}
+
+  publish-packages-to-npm:
+    runs-on: ubuntu-latest
+    if: "contains( github.event.head_commit.message, 'ci: release v')"
+    needs: publish-fargate-worker-image
+    permissions:
+      contents: read
+      packages: write
+    env:
+      NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      # this list should be kept in sync with create-release-pr.yml
+      PACKAGES_TO_RELEASE: "\
+        artillery-engine-playwright,\
+        artillery-plugin-apdex,\
+        artillery-plugin-ensure,\
+        artillery-plugin-expect,\
+        artillery-plugin-fake-data,\
+        artillery-plugin-metrics-by-endpoint,\
+        artillery-plugin-publish-metrics,\
+        commons,\
+        core,\
+        artillery,\
+        skytrace"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          registry-url: 'https://registry.npmjs.org'
+          scope: '@artilleryio'
+      - run: node .github/workflows/scripts/replace-worker-version-in-js-file.js
+        env:
+          COMMIT_SHA: ${{ github.sha }}
+      - run: node .github/workflows/scripts/rename-packages-to-correct-version.js
+        env:
+          PACKAGES_TO_REPLACE: ${{ env.PACKAGES_TO_RELEASE }}
+      # It must be published in this specific order to account for order of dependencies (e.g. artillery depends on commons, core, etc), in case failures happen in publishing.
+      - run: npm -w @artilleryio/int-commons publish
+      - run: npm -w @artilleryio/int-core publish
+      - run: npm -w artillery-plugin-expect publish
+      - run: npm -w artillery-plugin-publish-metrics publish
+      - run: npm -w artillery-plugin-metrics-by-endpoint publish
+      - run: npm -w artillery-plugin-ensure publish
+      - run: npm -w artillery-plugin-apdex publish
+      - run: npm -w artillery-engine-posthog publish
+      - run: npm -w artillery-engine-playwright publish
+      - run: npm -w artillery-plugin-fake-data publish
+      - run: npm -w artillery publish
+      # Skytrace is a Typescript Package and needs to install -> build -> publish
+      - run: npm install -w skytrace --ignore-scripts
+      - run: npm run build -w skytrace
+      - run: npm -w skytrace publish
+
+  publish-official-docker-image:
+    uses: ./.github/workflows/docker-publish-artillery.yml
+    needs: publish-packages-to-npm
+    with:
+      COMMIT_SHA: ${{ github.sha }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}