ci.yml

name: CI

on:
  pull_request:
  merge_group:

permissions:
  packages: write
  pull-requests: write

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  api-verification:
    name: API Verification
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

      - name: Set up Go
        uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5
        with:
          # NOTE(chrisgacsal): Use actions/cache for caching Go dependency and build caches
          # as if provides better flexibility like setting the cache key which reduces cache misses significantly.
          cache: false
          go-version-file: '.go-version'

      - name: Setup Go caching
        uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4
        with:
          path: |
            ~/.cache/go-build
            ~/go/pkg/mod
          key: ${{ runner.os }}-go-${{ github.ref_name }}-${{ hashFiles('**/go.sum') }}
          restore-keys: |
            ${{ runner.os }}-go-${{ github.ref_name }}-
            ${{ runner.os }}-go-${{ github.event.repository.default_branch }}-

      - name: Generate API code
        run: make gen-api

      # This step will evaluate the repo status and exit if found changes
      # This should detect if the most up-to-date generated API code was pushed
      - name: Changes validation
        run: |
          [[ -z "$(git status --porcelain)" ]] || exit 1

  helm-docs-verification:
    name: Helm Docs Verification
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

      - name: Generate Helm Docs
        run: make gen-helm-docs

      # This step will evaluate the repo status and exit if found changes
      # This should detect if the most up-to-date generated helm docs were pushed
      - name: Changes validation
        run: |
          [[ -z "$(git status --porcelain)" ]] || exit 1

  verification:
    needs: api-verification
    name: Verification
    uses: ./.github/workflows/reusable-verification.yml
    secrets: inherit

  build:
    needs: verification
    name: Build
    uses: ./.github/workflows/reusable-build-and-push.yml
    with:
      image_tag: ${{ format('pr{0}-{1}', github.event.pull_request.number, github.sha) }}
      push: true
      use_release_repository: false
      post_image_tags: true

  e2e:
    needs: build
    name: End-to-End
    uses: ./.github/workflows/reusable-end-to-end-testing.yml
    with:
      image_tag: ${{ format('pr{0}-{1}', github.event.pull_request.number, github.sha) }}
      use_release_repository: false

  success:
    # https://github.com/actions/runner/issues/2566
    # https://github.com/actions/toolkit/issues/581
    if: ${{ !cancelled() && !contains(needs.*.result, 'cancelled') && !contains(needs.*.result, 'failure') }}
    needs:
      - build
      - e2e
      - helm-docs-verification
    name: Success
    runs-on: ubuntu-latest
    steps:
      - name: Echo Success
        run: |
          echo "::notice Success!"