check-and-gen.yml

name: Check and Generate

on:
  pull_request:
  push:
    branches:
      - master
      - release/*
  workflow_dispatch:

defaults:
  run:
    shell: bash

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

permissions:
  contents: read

jobs:
  check-gen:
    name: Check (gen-check)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: 'recursive'
          fetch-depth: 0
      - uses: ./.github/actions/install-system-dependencies
      - uses: ./.github/actions/install-go
      - uses: ./.github/actions/make-deps
      - run: make gen
      - run: git diff --exit-code
  check-lint:
    name: Check (lint-all)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: 'recursive'
          fetch-depth: 0
      - uses: ./.github/actions/install-system-dependencies
      - uses: ./.github/actions/install-go
      - uses: ./.github/actions/make-deps
      - run: go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.59.0
      - run: golangci-lint run -v --timeout 10m --concurrency 4
  check-fmt:
    name: Check (gofmt)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: 'recursive'
          fetch-depth: 0
      - uses: ./.github/actions/install-go
      - run: go fmt ./...
      - run: git diff --exit-code
  check-mod-tidy:
    name: Check (mod-tidy-check)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: 'recursive'
          fetch-depth: 0
      - uses: ./.github/actions/install-go
      - run: go mod tidy -v
      - run: git diff --exit-code
  generate-docs:
    name: Generate Documentation
    runs-on: ubuntu-latest
    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/release/'))
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: 'recursive'
          fetch-depth: 0

      - uses: ./.github/actions/install-system-dependencies
      - uses: ./.github/actions/install-go
      - uses: ./.github/actions/make-deps

      - name: Generate API documentation using docsgen-cli
        run: |
          make docsgen-cli || {
            echo "Error: Documentation generation failed"
            exit 1
          }

      - name: Commit and push if documentation changed
        run: |
          if [ -n "$(git status --porcelain)" ]; then
           # Bot email is configured from: https://github.com/orgs/community/discussions/26560
            git config user.name "github-actions[bot]"
            git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
            git add .
            git commit -m "docs: update API documentation via docsgen-cli"
            git push
          else
            echo "No documentation changes to commit"
          fi