Create GitHub Release #35
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
| name: Create GitHub Release | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| artifact-run-id: | |
| description: 'GitHub Action Run ID containing artifacts' | |
| required: true | |
| type: string | |
| version-name: | |
| description: 'Version Name Override - E.g. "2024.11.1"' | |
| required: true | |
| type: string | |
| version-number: | |
| description: 'Version Number Override - E.g. "123456"' | |
| required: true | |
| type: string | |
| draft: | |
| description: 'Create as draft release' | |
| type: boolean | |
| default: true | |
| prerelease: | |
| description: 'Mark as pre-release' | |
| type: boolean | |
| default: true | |
| branch-protection-type: | |
| description: 'Branch protection type' | |
| type: choice | |
| options: | |
| - Branch Name | |
| - GitHub API | |
| default: Branch Name | |
| env: | |
| ARTIFACTS_PATH: artifacts | |
| jobs: | |
| create-release: | |
| name: Create GitHub Release | |
| runs-on: ubuntu-24.04 | |
| permissions: | |
| contents: write | |
| actions: read | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| fetch-depth: 0 | |
| - name: Get branch from workflow run | |
| id: get_release_branch | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| ARTIFACT_RUN_ID: ${{ inputs.artifact-run-id }} | |
| BRANCH_PROTECTION_TYPE: ${{ inputs.branch-protection-type }} | |
| run: | | |
| release_branch=$(gh run view $ARTIFACT_RUN_ID --json headBranch -q .headBranch) | |
| case "$BRANCH_PROTECTION_TYPE" in | |
| "Branch Name") | |
| if [[ "$release_branch" != "main" && ! "$release_branch" =~ ^release/ ]]; then | |
| echo "::error::Branch '$release_branch' is not 'main' or a release branch starting with 'release/'. Releases must be created from protected branches." | |
| exit 1 | |
| fi | |
| ;; | |
| "GitHub API") | |
| #NOTE requires token with "administration:read" scope | |
| if ! gh api "repos/${{ github.repository }}/branches/$release_branch/protection" | grep -q "required_status_checks"; then | |
| echo "::error::Branch '$release_branch' is not protected. Releases must be created from protected branches. If that's not correct, confirm if the github token user has the 'administration:read' scope." | |
| exit 1 | |
| fi | |
| ;; | |
| *) | |
| echo "::error::Unsupported branch protection type: $BRANCH_PROTECTION_TYPE" | |
| exit 1 | |
| ;; | |
| esac | |
| echo "release_branch=$release_branch" >> $GITHUB_OUTPUT | |
| - name: Get last release tag | |
| id: get_last_tag | |
| run: | | |
| last_release_id=$(git tag -l --sort=-authordate | head -n 1) | |
| echo "last_release_id=$last_release_id" >> $GITHUB_OUTPUT | |
| - name: Download artifacts | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| ARTIFACT_RUN_ID: ${{ inputs.artifact-run-id }} | |
| run: ./Scripts/download-artifacts.sh $ARTIFACTS_PATH $ARTIFACT_RUN_ID | |
| - name: Parse version info | |
| env: | |
| _VERSION_NAME: ${{ inputs.version-name }} | |
| _VERSION_NUMBER: ${{ inputs.version-number }} | |
| id: version_info | |
| run: | | |
| if [ ! -f ARTIFACTS_PATH/version_info.zip ]; then | |
| echo "::warning::version-version.zip not found. Confirm why the build workflow skipped uploading it." | |
| version_name="$_VERSION_NAME" | |
| version_number="$_VERSION_NUMBER" | |
| if [[ -z "$_VERSION_NAME" ]]; then | |
| echo "::warning::version name override input is empty. Using default value." | |
| version_name="0.0.0" | |
| fi | |
| if [[ -z "$_VERSION_NUMBER" ]]; then | |
| echo "::warning::version number override input is empty. Using default value." | |
| version_number="0" | |
| fi | |
| echo "version_number=$version_number" >> $GITHUB_OUTPUT | |
| echo "version_name=$version_name" >> $GITHUB_OUTPUT | |
| echo "Version: $version_name ($version_number)" | |
| exit 0 | |
| fi | |
| # version-info.zip was found, extracting info | |
| unzip -o "$ARTIFACTS_PATH/version-info.zip" -d "tmp" | |
| filepath="tmp/version-info/version_info.json" | |
| version_name=$(jq -r '.version_name' "$filepath") | |
| version_number=$(jq -r '.version_number' "$filepath") | |
| echo "version_number=$version_number" >> $GITHUB_OUTPUT | |
| echo "version_name=$version_name" >> $GITHUB_OUTPUT | |
| rm -rf tmp | |
| - name: Create GitHub Release | |
| id: create_release | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| # Create release with generated notes | |
| url=$(gh release create "v${{ steps.version_info.outputs.version_name }}" \ | |
| --title "${{ steps.version_info.outputs.version_name }} (${{ steps.version_info.outputs.version_number }})" \ | |
| --target ${{ steps.get_release_branch.outputs.release_branch }} \ | |
| --generate-notes \ | |
| --notes-start-tag "${{ steps.get_last_tag.outputs.last_release_id }}" \ | |
| --prerelease=${{ inputs.prerelease }} \ | |
| --draft=${{ inputs.draft }} \ | |
| $ARTIFACTS_PATH/*) | |
| # Extract release tag from URL | |
| release_id=$(echo "$url" | sed 's/.*\/tag\///') | |
| echo "release_id=$release_id" >> $GITHUB_OUTPUT | |
| - name: Update Release Description | |
| id: update_release_description | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| RELEASE_ID: ${{ steps.create_release.outputs.release_id }} | |
| ARTIFACT_RUN_ID: ${{ inputs.artifact-run-id }} | |
| run: | | |
| # Add builds source to the end of the release description | |
| current_body=$(gh release view $RELEASE_ID --json body --jq .body) | |
| updated_body="${current_body} | |
| **Builds Source:** https://github.com/${{ github.repository }}/actions/runs/$ARTIFACT_RUN_ID" | |
| new_url=$(gh release edit $RELEASE_ID --notes "$updated_body") | |
| # draft release links change after editing | |
| echo "release_url=$new_url" >> $GITHUB_OUTPUT | |
| - name: Add Release Summary | |
| env: | |
| RELEASE_ID: ${{ steps.create_release.outputs.release_id }} | |
| RELEASE_TAG: "v${{ steps.version_info.outputs.version_name }}" | |
| RELEASE_BRANCH: ${{ steps.get_release_branch.outputs.release_branch }} | |
| LAST_RELEASE_TAG: ${{ steps.get_last_tag.outputs.last_release_id }} | |
| RELEASE_URL: ${{ steps.update_release_description.outputs.release_url }} | |
| VERSION_NAME: ${{ steps.version_info.outputs.version_name }} | |
| VERSION_NUMBER: ${{ steps.version_info.outputs.version_number }} | |
| run: | | |
| echo "# :fish_cake: Release ready at:" >> $GITHUB_STEP_SUMMARY | |
| echo "$RELEASE_URL" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| if [[ "$VERSION_NAME" == "0.0.0" || "$VERSION_NUMBER" == "0" ]]; then | |
| echo "> [!CAUTION]" >> $GITHUB_STEP_SUMMARY | |
| echo "> Version name or number wasn't previously found and a default value was used. You'll need to manually update the release Title, Tag and Description, specifically, the "Full Changelog" link." >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| fi | |
| echo ":clipboard: Confirm that the defined GitHub Release options are correct:" >> $GITHUB_STEP_SUMMARY | |
| echo " * :bookmark: New tag name: \`$RELEASE_TAG\`" >> $GITHUB_STEP_SUMMARY | |
| echo " * :palm_tree: Target branch: \`$RELEASE_BRANCH\`" >> $GITHUB_STEP_SUMMARY | |
| echo " * :ocean: Previous tag set in the description \"Full Changelog\" link: \`$LAST_RELEASE_TAG\`" >> $GITHUB_STEP_SUMMARY | |
| echo " * :white_check_mark: Description has automated release notes and they match the commits in the release branch" >> $GITHUB_STEP_SUMMARY | |
| echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY | |
| echo "> Commits directly pushed to branches without a Pull Request won't appear in the automated release notes." >> $GITHUB_STEP_SUMMARY |