release.yaml

# This code is borrowed from https://github.com/kubernetes-sigs/cluster-api/blob/main/.github/workflows/release.yaml
name: Create Release

on:
  push:
    branches:
    - main
    paths:
    - 'releasenotes/*.md'

permissions: {}

jobs:
  push_release_tags:
    permissions:
      contents: write # Allow to push tags
    runs-on: ubuntu-latest
    outputs:
      release_tag: ${{ steps.release-version.outputs.release_version }}
    if: github.repository == 'kubernetes-sigs/cluster-api-provider-openstack'
    steps:
    - name: Checkout code # zizmor: ignore[artipacked]
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # tag=v6.0.2
      with:
        fetch-depth: 0
    - name: Get changed files
      id: changed-files
      uses: tj-actions/changed-files@22103cc46bda19c2b464ffe86db46df6922fd323 # v47.0.5
    - name: Get release version
      id: release-version
      env:
        STEPS_CHANGED_FILES_OUTPUTS_ALL_CHANGED_FILES_COUNT: ${{ steps.changed-files.outputs.all_changed_files_count }}
        STEPS_CHANGED_FILES_OUTPUTS_ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
      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 [[ -n "$(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 tags ${RELEASE_VERSION}"
  release:
    name: create draft release
    runs-on: ubuntu-latest
    needs: push_release_tags
    permissions:
      contents: write # Allow to create a release.
    steps:
    - name: Set env
      run: echo "RELEASE_TAG=${RELEASE_TAG}" >> ${GITHUB_ENV}
      env:
        RELEASE_TAG: ${{needs.push_release_tags.outputs.release_tag}}
    - name: checkout code # zizmor: ignore[artipacked]
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # tag=v6.0.2
      with:
        fetch-depth: 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@4a3601121dd01d1626a1e23e37211e3254c1c06c # tag=v6.4.0
      with:
        go-version: ${{ env.go_version }}
        cache: false
    - name: generate release artifacts
      run: |
        make release
      env:
        GH_TOKEN: ${{ github.token }}
    - name: get release notes
      run: |
        curl -fsSL "https://raw.githubusercontent.com/${{ github.repository }}/main/releasenotes/${RELEASE_TAG}.md" \
        -o "${RELEASE_TAG}.md"
    - name: Release
      run: |
        gh release create "${RELEASE_TAG}" \
          --draft \
          --notes-file "${RELEASE_TAG}.md" \
          out/*
      env:
        RELEASE_TAG: ${{ env.RELEASE_TAG }}
        GH_TOKEN: ${{ github.token }}