release.yaml

# Release builds and publish a new release.

# Secrets:
# TEST_REGISTRY_USER: registry user for the container registry
# TEST_REGISTRY_PASSWORD: password for container registry
# Vars:
# REGISTRY_URL: registry url for the container registry

name: Release

on:
    workflow_dispatch:
      inputs:
        nextVersion:
          description: 'specify the release version in the semver format v[major].[minor].[patch] e.g. v0.0.0'
          required: true

# Releases need permissions to read and write the repository contents.
# GitHub considers creating releases and uploading assets as writing contents.
permissions:
  contents: write
  packages: write

jobs:
    run-go-license-check:
      uses: ./.github/workflows/check-go-licenses.yaml

    run-reuse-license-check:
      uses: ./.github/workflows/reuse-scan.yaml

    run-unit-test:
      uses: ./.github/workflows/unit_test.yaml

    run-make-reviewable-and-check-diff:
      uses: ./.github/workflows/reviewable_check_diff.yaml

    run-e2e-test:
      uses: ./.github/workflows/e2e_test.yaml
      needs:
      - run-go-license-check
      - run-reuse-license-check
      - run-unit-test
      - run-make-reviewable-and-check-diff
      with:
        environment: pr-e2e-no-approval
      secrets:
        CLI_SERVER_URL: ${{ secrets.CLI_SERVER_URL }}
        GLOBAL_ACCOUNT: ${{ secrets.GLOBAL_ACCOUNT }}
        IDP_URL: ${{ secrets.IDP_URL }}
        SECOND_DIRECTORY_ADMIN_EMAIL: ${{ secrets.SECOND_DIRECTORY_ADMIN_EMAIL }}
        CIS_CENTRAL_BINDING: ${{ secrets.CIS_CENTRAL_BINDING }}
        BTP_TECHNICAL_USER: ${{ secrets.BTP_TECHNICAL_USER }}
        TECHNICAL_USER_EMAIL: ${{ secrets.TECHNICAL_USER_EMAIL }}

    release:
      runs-on: ubuntu-latest
      needs:
      - run-go-license-check
      - run-unit-test
      - run-make-reviewable-and-check-diff
      - run-e2e-test

      steps:
      - name: Print Version Number
        run: echo "Building release version ${{ github.event.inputs.nextVersion }}"

        # sets the github.event.inputs.nextVersion input as version tag
      - name: Tag head with version
        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
        with:
          script: |
            github.rest.git.createRef({
              owner: context.repo.owner,
              repo: context.repo.repo,
              ref: 'refs/tags/${{ github.event.inputs.nextVersion }}',
              sha: context.sha
            })

      - name: Setup Docker Buildx
        uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.4.0
        with:
          version: v0.15.1
          install: true

      - name: Checkout code
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          submodules: true

      - name: Fetch History
        run: git fetch --prune --unshallow

      - name: Set up Go
        uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
        with:
          go-version: '1.21'

      - name: Vendor Dependencies
        run: make vendor vendor.check

      - name: Build Images
        run: make build
        env:
          # We're using docker buildx, which doesn't actually load the images it
          # builds by default. Specifying --load does so.
          BUILD_ARGS: "--load"
          DOCKER_REGISTRY: ${{ vars.REGISTRY_URL }}
          BUILD_REGISTRY: ${{ vars.REGISTRY_URL }}

      - name: Login to Container Registry
        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
        with:
          registry: ${{ vars.REGISTRY_URL }}
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      - name: Publish Artifacts to DockerHub
        run: make publish BRANCH_NAME=${GITHUB_REF##*/}
        env:
          DOCKER_REGISTRY: ${{ vars.REGISTRY_URL }}
          BUILD_REGISTRY: ${{ vars.REGISTRY_URL }}

      - name: Run GoReleaser
        uses: goreleaser/goreleaser-action@9ed2f89a662bf1735a48bc8557fd212fa902bebf # v6.1.0
        with:
          distribution: goreleaser
          version: "~> v2"
          args: release --clean
        env:
          # GitHub sets the GITHUB_TOKEN secret automatically.
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}