From 16f38284b85953d52693bb6c11995a5ec7f7b333 Mon Sep 17 00:00:00 2001 From: Evan Sims Date: Tue, 28 Nov 2023 16:16:33 -0600 Subject: [PATCH] ci: Update Release Workflow --- .github/actions/get-prerelease/action.yml | 30 ++++++++++++++ .github/actions/get-version/action.yml | 23 +++++++++++ .github/actions/publish-package/action.yml | 29 +++++++++++++ .github/actions/release-create/action.yml | 47 ++++++++++++++++++++++ .github/actions/tag-create/action.yml | 33 +++++++++++++++ .github/actions/tag-exists/action.yml | 36 +++++++++++++++++ .github/workflows/release.yml | 25 ++++++++---- 7 files changed, 215 insertions(+), 8 deletions(-) create mode 100644 .github/actions/get-prerelease/action.yml create mode 100644 .github/actions/get-version/action.yml create mode 100644 .github/actions/publish-package/action.yml create mode 100644 .github/actions/release-create/action.yml create mode 100644 .github/actions/tag-create/action.yml create mode 100644 .github/actions/tag-exists/action.yml diff --git a/.github/actions/get-prerelease/action.yml b/.github/actions/get-prerelease/action.yml new file mode 100644 index 00000000..ce7acdc3 --- /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-version/action.yml b/.github/actions/get-version/action.yml new file mode 100644 index 00000000..387fdba6 --- /dev/null +++ b/.github/actions/get-version/action.yml @@ -0,0 +1,23 @@ +name: Return the version extracted from the branch name + +# +# Returns the version from a branch name of a pull request. 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. +# + +outputs: + version: + value: ${{ steps.get_version.outputs.VERSION }} + +runs: + using: composite + + steps: + - id: get_version + shell: bash + run: | + VERSION=$(echo ${BRANCH_NAME} | sed -r 's#release/+##g') + echo "VERSION=${VERSION}" >> $GITHUB_OUTPUT + env: + BRANCH_NAME: ${{ github.event.pull_request.head.ref }} diff --git a/.github/actions/publish-package/action.yml b/.github/actions/publish-package/action.yml new file mode 100644 index 00000000..d38b3e49 --- /dev/null +++ b/.github/actions/publish-package/action.yml @@ -0,0 +1,29 @@ +name: Publish release to package manager + +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 + +runs: + using: composite + + steps: + # Nothing to do for PHP. + - run: exit 0 + shell: bash diff --git a/.github/actions/release-create/action.yml b/.github/actions/release-create/action.yml new file mode 100644 index 00000000..6a2bf804 --- /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-create/action.yml b/.github/actions/tag-create/action.yml new file mode 100644 index 00000000..dc543291 --- /dev/null +++ b/.github/actions/tag-create/action.yml @@ -0,0 +1,33 @@ +name: Create a repository tag + +# +# Creates a tag with the given version. +# +# TODO: Remove once the common repo is public. +# + +inputs: + token: + required: true + tag: + required: true + +runs: + using: composite + + steps: + - shell: bash + run: | + git config user.name "${AUTHOR_USERNAME}" + git config user.email "${AUTHOR_EMAIL}" + env: + AUTHOR_USERNAME: ${{ github.event.pull_request.user.login }} + AUTHOR_EMAIL: ${{ github.event.pull_request.user.email }} + + - shell: bash + run: | + git tag -a ${TAG_NAME} -m "Version ${TAG_NAME}" + git push --follow-tags + env: + TAG_NAME: v${{ inputs.tag }} + 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 00000000..8fba29e6 --- /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: check + 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: v${{ inputs.tag }} + GITHUB_TOKEN: ${{ inputs.token }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ed518465..2cfdba62 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -8,6 +8,9 @@ on: permissions: contents: write +### TODO: Replace instances of './.github/actions/' w/ `auth0/dx-sdk-actions/` and append `@latest` after the common `dx-sdk-actions` repo's visibility is made public. +### TODO: Remove `get-prerelease`, `get-version`, `release-create`, `tag-create` and `tag-exists` actions once the common repo is public. + jobs: release: if: github.event.pull_request.merged && startsWith(github.event.pull_request.head.ref, 'release/') @@ -21,17 +24,17 @@ jobs: # Get the version from the branch name - id: get_version - uses: auth0/dx-sdk-actions/get-version@latest + uses: ./.github/actions/get-version # Get the prerelease flag from the branch name - id: get_prerelease - uses: auth0/dx-sdk-actions/get-prerelease@latest + uses: ./.github/actions/get-prerelease with: version: ${{ steps.get_version.outputs.version }} # Check if the tag already exists - id: tag_exists - uses: auth0/dx-sdk-actions/tag-exists@latest + uses: ./.github/actions/tag-exists with: tag: ${{ steps.get_version.outputs.version }} token: ${{ secrets.GITHUB_TOKEN }} @@ -40,18 +43,24 @@ jobs: - if: steps.tag_exists.outputs.exists == 'true' run: exit 1 - ######################################################################### - # Relevant build steps here - ######################################################################### + # Create a release for the tag + - uses: ./.github/actions/publish-package@latest + with: + token: ${{ secrets.GITHUB_TOKEN }} + name: ${{ steps.get_version.outputs.version }} + body: ${{ github.event.pull_request.body }} + tag: ${{ steps.get_version.outputs.version }} + commit: ${{ github.sha }} + prerelease: ${{ steps.get_prerelease.outputs.prerelease }} # Create a tag for the release - - uses: auth0/dx-sdk-actions/tag-create@latest + - uses: ./.github/actions/tag-create with: tag: ${{ steps.get_version.outputs.version }} token: ${{ secrets.GITHUB_TOKEN }} # Create a release for the tag - - uses: auth0/dx-sdk-actions/release-create@latest + - uses: ./.github/actions/release-create@latest with: token: ${{ secrets.GITHUB_TOKEN }} name: ${{ steps.get_version.outputs.version }}