-
Notifications
You must be signed in to change notification settings - Fork 269
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for automated release using GitHub Actions (#689)
### Description Adds the release workflow to use a fully automated release process, also removes the old publish workflow ### Testing - [ ] This change adds test coverage for new/changed/fixed functionality ### Checklist - [ ] I have added documentation for new/changed functionality in this PR or in auth0.com/docs - [ ] All active GitHub checks for tests, formatting, and security are passing - [ ] The correct base branch is being used, if not the default branch
- Loading branch information
1 parent
0518369
commit 182f4ab
Showing
8 changed files
with
291 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
name: Return the release notes extracted from the PR body | ||
|
||
# | ||
# 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 | ||
|
||
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.exportVariable('RELEASE_NOTES', pulls[0].body) | ||
env: | ||
GITHUB_TOKEN: ${{ inputs.token }} | ||
REPO_OWNER: ${{ inputs.repo_owner }} | ||
REPO_NAME: ${{ inputs.repo_name }} | ||
VERSION: ${{ inputs.version }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: Publish release to package manager | ||
|
||
inputs: | ||
node-version: | ||
required: true | ||
npm-token: | ||
required: true | ||
version: | ||
required: true | ||
|
||
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: Build package | ||
uses: ./.github/actions/build | ||
with: | ||
node: ${{ inputs.node-version }} | ||
|
||
- name: Publish release to NPM | ||
shell: bash | ||
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 }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: ${{ inputs.tag }} | ||
GITHUB_TOKEN: ${{ inputs.token }} |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.