openapi-generator.yaml

name: OpenAPI Generator

on:
  push:
    branches:
      - master
      - '[5-9]+.[0-9]+.x'
  pull_request:
    branches:
      - master
      - '[5-9]+.[0-9]+.x'

jobs:
  # Detect whether source files (modules/, pom.xml) changed.
  # When only samples/ or bin/configs/ changed, the unit tests and doc checks are skipped —
  # they are not affected by sample or config-only changes. The samples job still runs to
  # verify freshness. Nothing in bin/ affects mvn test; those scripts are used by the
  # documentation and samples jobs which run unconditionally.
  setup:
    name: Detect source changes
    runs-on: ubuntu-latest
    outputs:
      source-changed: ${{ steps.check.outputs.source-changed }}
    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0
      - id: check
        shell: bash
        env:
          BASE_SHA: ${{ github.event.pull_request.base.sha || github.event.before }}
          HEAD_SHA: ${{ github.sha }}
        run: |
          if [[ "$BASE_SHA" == "0000000000000000000000000000000000000000" ]] || [[ -z "$BASE_SHA" ]]; then
            BASE_SHA=$(git rev-parse HEAD~1 2>/dev/null || echo "")
          fi
          if [[ -n "$BASE_SHA" ]]; then
            CHANGED=$(git diff --name-only "$BASE_SHA" "$HEAD_SHA" 2>/dev/null || git diff --name-only HEAD~1 HEAD)
          else
            CHANGED=$(git diff --name-only HEAD~1 HEAD)
          fi
          if echo "$CHANGED" | grep -qE '^(modules/|pom\.xml|\.mvn/)'; then
            echo "source-changed=true" >> "$GITHUB_OUTPUT"
          else
            echo "source-changed=false" >> "$GITHUB_OUTPUT"
          fi

  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - name: Set up JDK 11
        uses: actions/setup-java@v5
        with:
          java-version: 11
          distribution: 'temurin'
          cache: gradle
      - name: Cache maven dependencies
        uses: actions/cache@v5
        env:
          cache-name: cache-maven-repository
        with:
          path: |
            ~/.m2/repository
            ~/.gradle
            !~/.gradle/caches/*/plugin-resolution/
            !~/.m2/repository/org/openapitools/
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/pom.xml') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
      - name: Run maven
        run: ./mvnw clean --no-snapshot-updates --batch-mode --quiet install -DskipTests -Dorg.slf4j.simpleLogger.defaultLogLevel=error
        env:
          GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
      - run: ls -la  modules/openapi-generator-cli/target
      - name: Upload openapi-generator-cli.jar artifact
        uses: actions/upload-artifact@v7
        with:
          name: openapi-generator-cli.jar
          path: modules/openapi-generator-cli/target/openapi-generator-cli.jar
          retention-days: 1

  test:
    name: Unit tests
    runs-on: ubuntu-latest
    needs:
      - setup
      - build
    # Unit tests are not affected by sample-only changes — skip to save CI time.
    if: needs.setup.outputs.source-changed == 'true'
    steps:
      - uses: actions/checkout@v5
      - name: Set up JDK 11
        uses: actions/setup-java@v5
        with:
          java-version: 11
          distribution: 'temurin'
          cache: gradle
      - name: Cache maven dependencies
        uses: actions/cache@v5
        env:
          cache-name: cache-maven-repository
        with:
          path: |
            ~/.m2/repository
            ~/.gradle
            !~/.gradle/caches/*/plugin-resolution/
            !~/.m2/repository/org/openapitools/
          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/pom.xml') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
      - name: Run unit tests
        run: ./mvnw clean --no-snapshot-updates --batch-mode --quiet --fail-at-end test -Dorg.slf4j.simpleLogger.defaultLogLevel=error
        env:
          GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
      - name: Publish unit test reports
        if: ${{ always() }}
        uses: actions/upload-artifact@v7
        with:
          name: surefire-test-results
          path: '**/surefire-reports/TEST-*.xml'

  documentation:
    name: Docs up-to-date
    runs-on: ubuntu-latest
    needs:
      - setup
      - build
    # Docs are generated from codegen metadata — skipped when only samples changed.
    if: needs.setup.outputs.source-changed == 'true'
    steps:
      - uses: actions/checkout@v5
      - name: Set up JDK 11
        uses: actions/setup-java@v5
        with:
          java-version: 11
          distribution: 'temurin'
      - name: Download openapi-generator-cli.jar artifact
        uses: actions/download-artifact@v8
        with:
          name: openapi-generator-cli.jar
          path: modules/openapi-generator-cli/target
      - name: Generate docs
        run: |
          bash bin/meta-codegen.sh
          bash bin/utils/export_docs_generators.sh
          bash bin/utils/copy-to-website.sh
          bash bin/utils/export_generators_readme.sh
      - name: Verify git status
        run: |
          if [[ "$(git status --porcelain)" != "" ]]; then
            echo "UNCOMMITTED CHANGES ERROR"
            echo "There are uncommitted changes in working tree after execution of 'bin/ensure-up-to-date'"
            echo "Perform git diff"
            git --no-pager diff
            echo "Perform git status"
            git status
            echo -e "\nThis script runs in pull requests against the anticipated merge commit (as if the PR was merged now)."
            echo "When you see unexpected files here, it likely means that there are newer commits in master that you need to "
            echo -e "rebase or merge into your branch.\n"
            echo "Please run 'bin/utils/ensure-up-to-date' locally and commit changes (UNCOMMITTED CHANGES ERROR)"
            exit 1
          fi

  samples:
    name: Samples up-to-date
    needs:
      - build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - name: Set up JDK 11
        uses: actions/setup-java@v5
        with:
          java-version: 11
          distribution: 'temurin'
      - name: Download openapi-generator-cli.jar artifact
        uses: actions/download-artifact@v8
        with:
          name: openapi-generator-cli.jar
          path: modules/openapi-generator-cli/target
      - name: Delete samples that are entirely generated
        run: |
          # List all directories in generichost, filter out Manual directories, and remove the rest
          cd samples/client/petstore/csharp/generichost
          for version_dir in */ ; do
            if [ -d "$version_dir" ]; then
              cd "$version_dir"
              for dir in */ ; do
                if [ -d "$dir" ] && [[ ! "$dir" =~ Manual ]]; then
                  rm -rf "$dir"
                fi
              done
              cd ..
            fi
          done
      - name: Generate samples
        run: |
          bash bin/generate-samples.sh
          # when a sample is deleted, you have to generate it twice for all files to get created
          bash bin/generate-samples.sh
      - name: Verify git status
        run: |
          if [[ "$(git status --porcelain)" != "" ]]; then
            echo "UNCOMMITTED CHANGES ERROR"
            echo "There are uncommitted changes in working tree after execution of 'bin/generate-samples.sh'"
            echo "Perform git diff"
            git --no-pager diff
            echo "Perform git status"
            git status
            echo -e "\nThis script runs in pull requests against the anticipated merge commit (as if the PR was merged now)."
            echo "When you see unexpected files here, it likely means that there are newer commits in master that you need to "
            echo -e "rebase or merge into your branch.\n"
            echo "Please run 'bin/generate-samples.sh' locally and commit changes (UNCOMMITTED CHANGES ERROR)"
            exit 1
          fi