-
Notifications
You must be signed in to change notification settings - Fork 431
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4366 from CecileRobertMichon/release-branch-action
Add automation to create release branch and tags
- Loading branch information
Showing
5 changed files
with
124 additions
and
46 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 |
|---|---|---|
| @@ -1,42 +1,119 @@ | ||
| name: Create Release | ||
|
|
||
| on: | ||
| push: | ||
| # Sequence of patterns matched against refs/tags | ||
| tags: | ||
| - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10 | ||
| branches: | ||
| - main | ||
| paths: | ||
| - 'CHANGELOG/*.md' | ||
|
|
||
| name: release | ||
| permissions: | ||
| contents: write # Allow to push a tag, create a release branch and publish a draft release. | ||
|
|
||
| jobs: | ||
| build: | ||
| name: tag release | ||
| push_release_tag: | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| release_tag: ${{ steps.release-version.outputs.release_version }} | ||
| steps: | ||
| - name: Harden Runner | ||
| uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1 | ||
| with: | ||
| egress-policy: audit | ||
| - name: Checkout code | ||
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # tag=v4.1.1 | ||
| with: | ||
| fetch-depth: 0 | ||
| - name: Get changed files | ||
| id: changed-files | ||
| uses: tj-actions/changed-files@1c938490c880156b746568a518594309cfb3f66b # tag=v40.2.1 | ||
| - name: Get release version | ||
| id: release-version | ||
| run: | | ||
| if [[ ${{ steps.changed-files.outputs.all_changed_files_count }} != 1 ]]; then | ||
| echo "1 release notes file should be changed to create a release tag, found ${{ steps.changed-files.outputs.all_changed_files_count }}" | ||
| exit 1 | ||
| fi | ||
| for changed_file in ${{ steps.changed-files.outputs.all_changed_files }}; do | ||
| export RELEASE_VERSION=$(echo "${changed_file}" | grep -oP '(?<=/)[^/]+(?=\.md)') | ||
| echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV | ||
| echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_OUTPUT | ||
| if [[ "$RELEASE_VERSION" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$ ]]; then | ||
| echo "Valid semver: $RELEASE_VERSION" | ||
| else | ||
| echo "Invalid semver: $RELEASE_VERSION" | ||
| exit 1 | ||
| fi | ||
| done | ||
| - name: Determine the release branch to use | ||
| run: | | ||
| if [[ $RELEASE_VERSION =~ beta ]] || [[ $RELEASE_VERSION =~ alpha ]]; then | ||
| export RELEASE_BRANCH=main | ||
| echo "RELEASE_BRANCH=$RELEASE_BRANCH" >> $GITHUB_ENV | ||
| echo "This is a beta or alpha release, will use release branch $RELEASE_BRANCH" | ||
| else | ||
| export RELEASE_BRANCH=release-$(echo $RELEASE_VERSION | sed -E 's/^v([0-9]+)\.([0-9]+)\..*$/\1.\2/') | ||
| echo "RELEASE_BRANCH=$RELEASE_BRANCH" >> $GITHUB_ENV | ||
| echo "This is not a beta or alpha release, will use release branch $RELEASE_BRANCH" | ||
| fi | ||
| - name: Create or checkout release branch | ||
| run: | | ||
| if git show-ref --verify --quiet "refs/remotes/origin/$RELEASE_BRANCH"; then | ||
| echo "Branch $RELEASE_BRANCH already exists" | ||
| git checkout "$RELEASE_BRANCH" | ||
| else | ||
| git checkout -b "$RELEASE_BRANCH" | ||
| git push origin "$RELEASE_BRANCH" | ||
| echo "Created branch $RELEASE_BRANCH" | ||
| fi | ||
| - name: Validate tag does not already exist | ||
| run: | | ||
| if [[ $(git tag -l $RELEASE_VERSION) ]]; then | ||
| echo "Tag $RELEASE_VERSION already exists, exiting" | ||
| exit 1 | ||
| fi | ||
| - name: Create Release Tag | ||
| run: | | ||
| git config user.name "${GITHUB_ACTOR}" | ||
| git config user.email "${GITHUB_ACTOR}@users.noreply.github.com" | ||
| git tag -a ${RELEASE_VERSION} -m ${RELEASE_VERSION} | ||
| git push origin ${RELEASE_VERSION} | ||
| echo "Created tag $RELEASE_VERSION" | ||
| release: | ||
| name: create draft release | ||
| runs-on: ubuntu-latest | ||
| needs: push_release_tag | ||
| steps: | ||
| - name: Harden Runner | ||
| uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1 | ||
| with: | ||
| egress-policy: audit | ||
|
|
||
| - name: Set env | ||
| run: echo "RELEASE_TAG=${GITHUB_REF:10}" >> $GITHUB_ENV | ||
| run: echo "RELEASE_TAG=${RELEASE_TAG}" >> $GITHUB_ENV | ||
| env: | ||
| RELEASE_TAG: ${{needs.push_release_tag.outputs.release_tag}} | ||
| - name: checkout code | ||
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # tag=v4.1.1 | ||
| with: | ||
| fetch-depth: 0 | ||
| - name: Install go | ||
| uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0 | ||
| ref: ${{ env.RELEASE_TAG }} | ||
| - name: Calculate go version | ||
| run: echo "go_version=$(make go-version)" >> $GITHUB_ENV | ||
| - name: Set up Go | ||
| uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # tag=v4.1.0 | ||
| with: | ||
| go-version: '^1.20' | ||
| go-version: ${{ env.go_version }} | ||
| - name: generate release artifacts | ||
| run: | | ||
| make release | ||
| - name: generate release notes | ||
| - name: get release notes | ||
| run: | | ||
| make release-notes | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| curl -L "https://raw.githubusercontent.com/${{ github.repository }}/main/CHANGELOG/${{ env.RELEASE_TAG }}.md" \ | ||
| -o "${{ env.RELEASE_TAG }}.md" | ||
| - name: Release | ||
| uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1 | ||
| uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # tag=v1 | ||
| with: | ||
| draft: true | ||
| files: out/* | ||
| body_path: _releasenotes/release-notes-${{ env.RELEASE_TAG }}.md | ||
| body_path: ${{ env.RELEASE_TAG }}.md | ||
| tag_name: ${{ env.RELEASE_TAG }} |
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
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,5 @@ | ||
| # CHANGELOG | ||
|
|
||
| This folder contains release notes for past releases. Changes to this folder in the main branch trigger a GitHub Action that creates release tags and a draft release. | ||
|
|
||
| See [release documentation](https://capz.sigs.k8s.io/developers/releasing) for more information. |
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
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