This repository was archived by the owner on Aug 29, 2023. It is now read-only.
Create GitHub releases in releaser/tag-pusher workflows #299
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -1,144 +1,166 @@ | ||
| name: Release Checker | ||
| on: [ workflow_call ] | ||
|
|
||
| jobs: | ||
| prepare: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| outputs: | ||
| version: ${{ steps.version.outputs.this }} | ||
| tag_exists: ${{ steps.tag_exists.outputs.this }} | ||
| steps: | ||
| - id: version | ||
| name: Retrieve new version from version.json | ||
| run: | | ||
| # https://docs.github.com/en/rest/reference/repos#get-repository-content | ||
| version="$(gh api -X GET 'repos/${{ github.event.pull_request.head.repo.full_name }}/contents/version.json' -f ref='${{ github.event.pull_request.head.sha }}' --jq '.content' | base64 -d | jq -r '.version // ""')" | ||
| status=$? && ([[ $status == 0 ]] || exit $status) | ||
| echo "version=$version" | ||
| echo "::set-output name=this::$version" | ||
| - id: tag_exists | ||
| name: Check if version tag already exists | ||
| if: steps.version.outputs.this != '' | ||
| run: | | ||
| # https://docs.github.com/en/rest/reference/git#get-a-reference | ||
| gh api '/repos/${{ github.repository }}/git/ref/tags/${{ steps.version.outputs.this }}' && tag_exists='true' || tag_exists='false' | ||
|
Contributor
There was a problem hiding this comment. We're using string interpolation at the yml level here, is it possible a malformed value in Should we use something like: env:
TAG_URL: /repos/${{ github.repository }}/git/ref/tags/${{ steps.version.outputs.this }}
run:
gh api "${TAG_URL}" # using shell's expansion here? |
||
|
|
||
| echo "tag_exists=$tag_exists" | ||
| echo "::set-output name=this::$tag_exists" | ||
| check: | ||
| needs: [prepare] | ||
| if: needs.prepare.outputs.tag_exists != 'true' | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| COMMENT: "Suggested version: `${{ needs.prepare.outputs.version }}`" | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| steps: | ||
| - name: Check version | ||
| run: | | ||
| npm install -g 'https://github.com/npm/node-semver#e79ac3a450e8bb504e78b8159e3efc7089569' # v7.3.5 | ||
|
|
||
| semver '${{ needs.prepare.outputs.version }}' # fails if the version is not a valid semver version (e.g. v0.1 would fail) | ||
| - id: release | ||
| name: Create draft GitHub Release (if it doesn't exist yet) | ||
| run: | | ||
| # using GraphQL because https://docs.github.com/en/rest/reference/releases#list-releases does not return draft releases | ||
| # https://docs.github.com/en/graphql/reference/objects#release | ||
| release="$(gh api graphql -f query='query { repository(owner: "${{ github.event.repository.owner.login }}", name: "${{ github.event.repository.name }}") { release(tagName: "${{ needs.prepare.outputs.version }}") { url } } }' --jq '.data.repository.release.url // ""')" | ||
| status=$? && ([[ $status == 0 ]] || exit $status) | ||
|
|
||
| if [[ -z "$release" ]]; then | ||
| # https://docs.github.com/en/rest/reference/releases#create-a-release | ||
| # creating a draft release does not create a tag, only publishing does | ||
| release="$(gh api '/repos/${{ github.repository }}/releases' -F 'draft=true' -f 'tag_name=${{ needs.prepare.outputs.version }}' -F 'generate_release_notes=true' --jq '.html_url')" | ||
| status=$? && ([[ $status == 0 ]] || exit $status) | ||
| fi | ||
|
|
||
| echo "COMMENT<<EOF | ||
|
Contributor
There was a problem hiding this comment. TIL... cool pattern :) Do we need to worry about script injection here? |
||
| $COMMENT | ||
|
|
||
| Draft GitHub Release: [\`${{ needs.prepare.outputs.version }}\`](https://github.com/${{ github.repository }}/releases?q=draft%3Atrue+tag%3A${{ needs.prepare.outputs.version }}) | ||
| Merging the PR will publish the release. All modifications to the draft will be preserved. In particular, deleting the draft will prevent the release from getting published. | ||
| EOF" >> $GITHUB_ENV | ||
| - uses: actions/setup-go@v2 | ||
| with: | ||
| go-version: "1.17.x" | ||
| - id: prev_version | ||
| name: Determine version number to compare to | ||
| # We need to determine the version number we want to compare to, | ||
| # taking into account that this might be a (patch) release on a release branch. | ||
| # Example: | ||
| # Imagine a module that has releases for v0.1.0, v0.2.0 and v0.3.0. | ||
| # When trying to cut a release v0.2.1, we need to base our comparisons on v0.2.0. | ||
| # When trying to cut a release v0.3.1 or v0.4.0, we need to base our comparisons on v0.3.0. | ||
| run: | | ||
| go install github.com/marten-seemann/semver-highest@fcdc98f8820ff0e6613c1bee071c096febd98dbf | ||
|
|
||
| versions="$(gh api --paginate '/repos/${{ github.repository }}/tags' --jq 'map(.name)' | jq -nr '[inputs] | add | join(",")')" | ||
| status=$? && ([[ $status == 0 ]] || exit $status) | ||
|
|
||
| prev_version="$(semver-highest -target '${{ needs.prepare.outputs.version }}' -versions "$versions")" | ||
|
|
||
| echo "prev_version=$prev_version" | ||
| echo "::set-output name=this::$prev_version" | ||
|
|
||
| if [[ -z "$prev_version" ]]; then | ||
| output="This is the first release of this module." | ||
| else | ||
| output="Comparing to: [\`$prev_version\`](${{ github.event.pull_request.base.repo.html_url }}/releases/tag/$prev_version) ([diff](${{ github.event.pull_request.base.repo.html_url }}/compare/$prev_version..${{ github.event.pull_request.head.label }}))" | ||
| fi | ||
|
|
||
| echo "COMMENT<<EOF | ||
| $COMMENT | ||
|
|
||
| $output | ||
| EOF" >> $GITHUB_ENV | ||
| - uses: actions/checkout@v2 | ||
| if: steps.prev_version.outputs.this != '' | ||
| - if: steps.prev_version.outputs.this != '' | ||
| run: git fetch origin --tags | ||
| - name: Run git diff on go.mod file(s) | ||
| if: steps.prev_version.outputs.this != '' | ||
| run: | | ||
| # First get the diff for the go.mod file in the root directory... | ||
| output="$(git diff ${{ steps.prev_version.outputs.this }}..HEAD -- './go.mod')" | ||
|
|
||
| # ... then get the diff for all go.mod files in subdirectories. | ||
| # Note that this command also finds go.mod files more than one level deep in the directory structure. | ||
| output+="$(git diff ${{ steps.prev_version.outputs.this }}..HEAD -- '*/go.mod')" | ||
|
|
||
| echo "COMMENT<<EOF | ||
| $COMMENT | ||
|
|
||
| Changes in \`go.mod\` file(s): | ||
| \`\`\`diff | ||
| $output | ||
| \`\`\` | ||
| EOF" >> $GITHUB_ENV | ||
| - name: Run gorelease | ||
| if: steps.prev_version.outputs.this != '' | ||
| # see https://github.com/golang/exp/commits/master/cmd/gorelease | ||
| run: | | ||
| go install golang.org/x/exp/cmd/gorelease@b4e88ed8e8aab63a9aa9a52276782ebbc547adef | ||
|
|
||
| output="$((gorelease -base ${{ steps.prev_version.outputs.this }}) 2>&1 || true)" | ||
|
|
||
| echo "COMMENT<<EOF | ||
| $COMMENT | ||
|
|
||
| \`gorelease\` says: | ||
| \`\`\`diff | ||
| $output | ||
| \`\`\` | ||
| EOF" >> $GITHUB_ENV | ||
| - name: Check compatibility | ||
| if: steps.prev_version.outputs.this != '' | ||
| run: | | ||
| go install github.com/smola/gocompat/cmd/gocompat@8498b97a44792a3a6063c47014726baa63e2e669 # v0.3.0 | ||
|
|
||
| output="$(gocompat compare --go1compat --git-refs='${{ steps.prev_version.outputs.this }}..HEAD' ./... || true)" | ||
|
|
||
| echo "COMMENT<<EOF | ||
| $COMMENT | ||
|
|
||
| \`gocompat\` says: | ||
| \`\`\`diff | ||
| $output | ||
| \`\`\` | ||
| EOF" >> $GITHUB_ENV | ||
| - name: Add a note for PRs targeting release branches | ||
| if: github.base_ref != github.event.repository.default_branch | ||
| run: | | ||
| echo "COMMENT<<EOF | ||
| $COMMENT | ||
|
|
||
| ## Cutting a Release (when not on \`${{ github.event.repository.default_branch }}\`) | ||
|
|
||
| This PR is targeting \`${{ github.base_ref }}\`, which is not the default branch. | ||
| If you wish to cut a release once this PR is merged, please add the \`release\` label to this PR. | ||
| EOF" >> $GITHUB_ENV | ||
| - name: Post message on PR | ||
| uses: marocchino/sticky-pull-request-comment@82e7a0d3c51217201b3fedc4ddde6632e969a477 # v2.1.1 | ||
| with: | ||
| header: release-check | ||
| recreate: true | ||
| message: ${{ env.COMMENT }} | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| name: Release Checker | ||
| on: | ||
| pull_request_target: | ||
| paths-ignore: [ '!version.json' ] | ||
|
|
||
| jobs: | ||
| release-check: | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we use
echo "{name}={value}" >> $GITHUB_OUTPUT?https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/