From 1f3964e8a80cadabedf57b5de5736d1ff17cc251 Mon Sep 17 00:00:00 2001
From: Frederik Prijck <frederik.prijck@auth0.com>
Date: Fri, 15 Dec 2023 12:54:09 +0100
Subject: [PATCH] Update automated release process to latest version (#1611)

---
 .github/actions/get-prerelease/action.yml    |  30 +++++
 .github/actions/get-release-notes/action.yml |  42 +++++++
 .github/actions/get-version/action.yml       |  21 ++++
 .github/actions/npm-publish/action.yml       |  52 +++++++++
 .github/actions/release-create/action.yml    |  47 ++++++++
 .github/actions/tag-exists/action.yml        |  36 ++++++
 .github/workflows/npm-release.yml            |  83 ++++++++++++++
 .github/workflows/publish.yml                | 110 -------------------
 .github/workflows/release.yml                |  25 +++++
 .shiprc                                      |   3 +-
 .version                                     |   1 +
 11 files changed, 339 insertions(+), 111 deletions(-)
 create mode 100644 .github/actions/get-prerelease/action.yml
 create mode 100644 .github/actions/get-release-notes/action.yml
 create mode 100644 .github/actions/get-version/action.yml
 create mode 100644 .github/actions/npm-publish/action.yml
 create mode 100644 .github/actions/release-create/action.yml
 create mode 100644 .github/actions/tag-exists/action.yml
 create mode 100644 .github/workflows/npm-release.yml
 delete mode 100644 .github/workflows/publish.yml
 create mode 100644 .github/workflows/release.yml
 create mode 100644 .version

diff --git a/.github/actions/get-prerelease/action.yml b/.github/actions/get-prerelease/action.yml
new file mode 100644
index 000000000..ce7acdc3b
--- /dev/null
+++ b/.github/actions/get-prerelease/action.yml
@@ -0,0 +1,30 @@
+name: Return a boolean indicating if the version contains prerelease identifiers
+
+#
+# Returns a simple true/false boolean indicating whether the version indicates it's a prerelease or not.
+#
+# TODO: Remove once the common repo is public.
+#
+
+inputs:
+  version:
+    required: true
+
+outputs:
+  prerelease:
+    value: ${{ steps.get_prerelease.outputs.PRERELEASE }}
+
+runs:
+  using: composite
+
+  steps:
+    - id: get_prerelease
+      shell: bash
+      run: |
+        if [[ "${VERSION}" == *"beta"* || "${VERSION}" == *"alpha"* ]]; then
+          echo "PRERELEASE=true" >> $GITHUB_OUTPUT
+        else
+          echo "PRERELEASE=false" >> $GITHUB_OUTPUT
+        fi
+      env:
+        VERSION: ${{ inputs.version }}
diff --git a/.github/actions/get-release-notes/action.yml b/.github/actions/get-release-notes/action.yml
new file mode 100644
index 000000000..287d2066c
--- /dev/null
+++ b/.github/actions/get-release-notes/action.yml
@@ -0,0 +1,42 @@
+name: Return the release notes extracted from the body of the PR associated with the release.
+
+#
+# Returns the release notes from the content of a pull request linked to a release branch. It expects the branch name to be in the format release/vX.Y.Z, release/X.Y.Z, release/vX.Y.Z-beta.N. etc.
+#
+# TODO: Remove once the common repo is public.
+#
+inputs:
+  version:
+    required: true
+  repo_name:
+    required: false
+  repo_owner:
+    required: true
+  token:
+    required: true
+
+outputs:
+  release-notes:
+    value: ${{ steps.get_release_notes.outputs.RELEASE_NOTES }}
+
+runs:
+  using: composite
+
+  steps:
+    - uses: actions/github-script@v7
+      id: get_release_notes
+      with:
+        result-encoding: string
+        script: |
+          const { data: pulls } = await github.rest.pulls.list({
+            owner: process.env.REPO_OWNER,
+            repo: process.env.REPO_NAME,
+            state: 'all',
+            head: `${process.env.REPO_OWNER}:release/${process.env.VERSION}`,
+          });
+          core.setOutput('RELEASE_NOTES', pulls[0].body);
+      env:
+        GITHUB_TOKEN: ${{ inputs.token }}
+        REPO_OWNER: ${{ inputs.repo_owner }}
+        REPO_NAME: ${{ inputs.repo_name }}
+        VERSION: ${{ inputs.version }}
diff --git a/.github/actions/get-version/action.yml b/.github/actions/get-version/action.yml
new file mode 100644
index 000000000..9440ec920
--- /dev/null
+++ b/.github/actions/get-version/action.yml
@@ -0,0 +1,21 @@
+name: Return the version extracted from the branch name
+
+#
+# Returns the version from the .version file.
+#
+# TODO: Remove once the common repo is public.
+#
+
+outputs:
+  version:
+    value: ${{ steps.get_version.outputs.VERSION }}
+
+runs:
+  using: composite
+
+  steps:
+    - id: get_version
+      shell: bash
+      run: |
+        VERSION=$(head -1 .version)
+        echo "VERSION=${VERSION}" >> $GITHUB_OUTPUT
diff --git a/.github/actions/npm-publish/action.yml b/.github/actions/npm-publish/action.yml
new file mode 100644
index 000000000..57679d5c3
--- /dev/null
+++ b/.github/actions/npm-publish/action.yml
@@ -0,0 +1,52 @@
+name: Publish release to npm
+
+inputs:
+  node-version:
+    required: true
+  npm-token:
+    required: true
+  version:
+    required: true
+  require-build:
+    default: true
+  release-directory:
+    default: './'
+
+runs:
+  using: composite
+
+  steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup Node
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ inputs.node-version }}
+        cache: 'npm'
+        registry-url: 'https://registry.npmjs.org'
+
+    - name: Install dependencies
+      shell: bash
+      run: npm ci --include=dev
+
+    - name: Build package
+      if: inputs.require-build == 'true'
+      shell: bash
+      run: npm run build
+
+    - name: Publish release to NPM
+      shell: bash
+      working-directory: ${{ inputs.release-directory }}
+      run: |
+        if [[ "${VERSION}" == *"beta"* ]]; then
+          TAG="beta"
+        elif [[ "${VERSION}" == *"alpha"* ]]; then
+          TAG="alpha"
+        else
+          TAG="latest"
+        fi
+        npm publish --provenance --tag $TAG
+      env:
+        NODE_AUTH_TOKEN: ${{ inputs.npm-token }}
+        VERSION: ${{ inputs.version }}
diff --git a/.github/actions/release-create/action.yml b/.github/actions/release-create/action.yml
new file mode 100644
index 000000000..6a2bf804c
--- /dev/null
+++ b/.github/actions/release-create/action.yml
@@ -0,0 +1,47 @@
+name: Create a GitHub release
+
+#
+# Creates a GitHub release with the given version.
+#
+# TODO: Remove once the common repo is public.
+#
+
+inputs:
+  token:
+    required: true
+  files:
+    required: false
+  name:
+    required: true
+  body:
+    required: true
+  tag:
+    required: true
+  commit:
+    required: true
+  draft:
+    default: false
+    required: false
+  prerelease:
+    default: false
+    required: false
+  fail_on_unmatched_files:
+    default: true
+    required: false
+
+runs:
+  using: composite
+
+  steps:
+    - uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844
+      with:
+        body: ${{ inputs.body }}
+        name: ${{ inputs.name }}
+        tag_name: ${{ inputs.tag }}
+        target_commitish: ${{ inputs.commit }}
+        draft: ${{ inputs.draft }}
+        prerelease: ${{ inputs.prerelease }}
+        fail_on_unmatched_files: ${{ inputs.fail_on_unmatched_files }}
+        files: ${{ inputs.files }}
+      env:
+        GITHUB_TOKEN: ${{ inputs.token }}
diff --git a/.github/actions/tag-exists/action.yml b/.github/actions/tag-exists/action.yml
new file mode 100644
index 000000000..b5fbdb730
--- /dev/null
+++ b/.github/actions/tag-exists/action.yml
@@ -0,0 +1,36 @@
+name: Return a boolean indicating if a tag already exists for the repository
+
+#
+# Returns a simple true/false boolean indicating whether the tag exists or not.
+#
+# TODO: Remove once the common repo is public.
+#
+
+inputs:
+  token:
+    required: true
+  tag:
+    required: true
+
+outputs:
+  exists:
+    description: 'Whether the tag exists or not'
+    value: ${{ steps.tag-exists.outputs.EXISTS }}
+
+runs:
+  using: composite
+
+  steps:
+    - id: tag-exists
+      shell: bash
+      run: |
+        GET_API_URL="https://api.github.com/repos/${GITHUB_REPOSITORY}/git/ref/tags/${TAG_NAME}"
+        http_status_code=$(curl -LI $GET_API_URL -o /dev/null -w '%{http_code}\n' -s -H "Authorization: token ${GITHUB_TOKEN}")
+        if [ "$http_status_code" -ne "404" ] ; then
+          echo "EXISTS=true" >> $GITHUB_OUTPUT
+        else
+          echo "EXISTS=false" >> $GITHUB_OUTPUT
+        fi
+      env:
+        TAG_NAME: ${{ inputs.tag }}
+        GITHUB_TOKEN: ${{ inputs.token }}
diff --git a/.github/workflows/npm-release.yml b/.github/workflows/npm-release.yml
new file mode 100644
index 000000000..21a57c446
--- /dev/null
+++ b/.github/workflows/npm-release.yml
@@ -0,0 +1,83 @@
+name: Create npm and GitHub Release
+
+on:
+  workflow_call:
+    inputs:
+      node-version:
+        required: true
+        type: string
+      require-build:
+        default: true
+        type: string
+      release-directory:
+        default: './'
+        type: string
+    secrets:
+      github-token:
+        required: true
+      npm-token:
+        required: true
+
+### TODO: Replace instances of './.github/actions/' w/ `auth0/dx-sdk-actions/` and append `@latest` after the common `dx-sdk-actions` repo is made public.
+### TODO: Also remove `get-prerelease`, `get-version`, `release-create`, `tag-create` and `tag-exists` actions from this repo's .github/actions folder once the repo is public.
+
+jobs:
+  release:
+    if: github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request' && github.event.pull_request.merged && startsWith(github.event.pull_request.head.ref, 'release/'))
+    runs-on: ubuntu-latest
+    environment: release
+
+    steps:
+      # Checkout the code
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # Get the version from the branch name
+      - id: get_version
+        uses: ./.github/actions/get-version
+
+      # Get the prerelease flag from the branch name
+      - id: get_prerelease
+        uses: ./.github/actions/get-prerelease
+        with:
+          version: ${{ steps.get_version.outputs.version }}
+
+      # Get the release notes
+      - id: get_release_notes
+        uses: ./.github/actions/get-release-notes
+        with:
+          token: ${{ secrets.github-token }}
+          version: ${{ steps.get_version.outputs.version }}
+          repo_owner: ${{ github.repository_owner }}
+          repo_name: ${{ github.event.repository.name }}
+
+      # Check if the tag already exists
+      - id: tag_exists
+        uses: ./.github/actions/tag-exists
+        with:
+          tag: ${{ steps.get_version.outputs.version }}
+          token: ${{ secrets.github-token }}
+
+      # If the tag already exists, exit with an error
+      - if: steps.tag_exists.outputs.exists == 'true'
+        run: exit 1
+
+      # Publish the release to npm
+      - uses: ./.github/actions/npm-publish
+        with:
+          node-version: ${{ inputs.node-version }}
+          require-build: ${{ inputs.require-build }}
+          release-directory: ${{ inputs.release-directory }}
+          version: ${{ steps.get_version.outputs.version }}
+          npm-token: ${{ secrets.npm-token }}
+
+      # Create a release for the tag
+      - uses: ./.github/actions/release-create
+        with:
+          token: ${{ secrets.github-token }}
+          name: ${{ steps.get_version.outputs.version }}
+          body: ${{ steps.get_release_notes.outputs.release-notes }}
+          tag: ${{ steps.get_version.outputs.version }}
+          commit: ${{ github.sha }}
+          prerelease: ${{ steps.get_prerelease.outputs.prerelease }}
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
deleted file mode 100644
index 9155f8b39..000000000
--- a/.github/workflows/publish.yml
+++ /dev/null
@@ -1,110 +0,0 @@
-name: Publish Release
-
-on:
-  workflow_dispatch:
-    inputs:
-      branch:
-        description: The branch to release from
-        required: true
-        default: main
-      version:
-        description: The version being published. This should be a valid semver version, such as `1.0.0`.
-        required: true
-        default: ''
-        type: string
-      dry-run:
-        type: boolean
-        description: Perform a publishing dry run. This will not publish the release, but will validate the release and log the commands that would be run.
-        default: false
-
-permissions:
-  contents: read
-  id-token: write # For publishing to NPM with provenance. Allows developers to run `npm audit signatures` and verify release signature of SDK. @see https://github.blog/2023-04-19-introducing-npm-package-provenance/
-  packages: write # For cross-publishing to GitHub Packages registry.
-
-env:
-  NODE_VERSION: 18
-  NODE_ENV: development
-
-jobs:
-  configure:
-    name: Validate input parameters
-    runs-on: ubuntu-latest
-
-    outputs:
-      vtag: ${{ steps.vtag.outputs.vtag }} # The fully constructed release tag to use for publishing
-      dry-run: ${{ steps.dry-run.outputs.dry-run }} # The dry-run flag to use for publishing, if applicable
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          ref: ${{ github.event.inputs.branch }}
-
-      # Configure for dry-run, if applicable. @see https://docs.npmjs.com/cli/v9/commands/npm-publish#dry-run
-      - id: dry-run
-        if: ${{ github.event.inputs.dry-run == 'true' }}
-        name: Configure for `--dry-run`
-        run: |
-          echo "dry-run=--dry-run" >> $GITHUB_ENV
-          echo "dry-run=--dry-run" >> $GITHUB_OUTPUT
-
-      # Build the tag string from package.json version and release suffix. Produces something like `1.0.0-beta.1` for a beta, or `1.0.0` for a stable release.
-      - name: Build tag
-        id: vtag
-        run: |
-          PACKAGE_VERSION="${{ github.event.inputs.version }}"
-          echo "vtag=${PACKAGE_VERSION}" >> $GITHUB_ENV
-          echo "vtag=${PACKAGE_VERSION}" >> $GITHUB_OUTPUT
-
-      # Ensure tag does not already exist.
-      - name: Validate version
-        uses: actions/github-script@v7
-        env:
-          vtag: ${{ env.vtag }}
-        with:
-          script: |
-            const releaseMeta = github.rest.repos.listReleases.endpoint.merge({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-            });
-
-            const releases = await github.paginate(releaseMeta);
-
-            for (const release of releases) {
-              if (release.name === process.env.vtag) {
-                throw new Error(`${process.env.vtag} already exists`);
-              }
-            }
-
-            console.log(`${process.env.vtag} does not exist. Proceeding with release.`)
-
-  publish-npm:
-    needs: configure
-
-    name: Publish to NPM
-    runs-on: ubuntu-latest
-    environment: 'release'
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          ref: ${{ github.event.inputs.branch }}
-
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-          cache: npm
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Publish release to NPM
-        run: npm publish --provenance --tag ${{ needs.configure.outputs.vtag }} ${{ needs.configure.outputs.dry-run }}
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 000000000..e6c8430d1
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,25 @@
+name: Create GitHub Release
+
+on:
+  pull_request:
+    types:
+      - closed
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  id-token: write # For publishing to npm using --provenance
+
+### TODO: Replace instances of './.github/workflows/' w/ `auth0/dx-sdk-actions/workflows/` and append `@latest` after the common `dx-sdk-actions` repo is made public.
+### TODO: Also remove `get-prerelease`, `get-release-notes`, `get-version`, `npm-publish`, `release-create`, and `tag-exists` actions from this repo's .github/actions folder once the repo is public.
+### TODO: Also remove `npm-release` workflow from this repo's .github/workflows folder once the repo is public.
+
+jobs:
+  release:
+    uses: ./.github/workflows/npm-release.yml
+    with:
+      node-version: 18
+      require-build: false
+    secrets:
+      npm-token: ${{ secrets.NPM_TOKEN }}
+      github-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.shiprc b/.shiprc
index c456d06dc..dcbf0d41a 100644
--- a/.shiprc
+++ b/.shiprc
@@ -1,6 +1,7 @@
 {
     "files": {
-        "src/version.ts": []
+        "src/version.ts": [],
+        ".version": []
     },
     "postbump": "npm run docs"
 }
diff --git a/.version b/.version
new file mode 100644
index 000000000..4d0729e54
--- /dev/null
+++ b/.version
@@ -0,0 +1 @@
+v3.5.0
\ No newline at end of file