Skip CI run on docs changes #9946
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - release-* | |
| tags: | |
| - "v[0-9]+.[0-9]+.[0-9]+*" | |
| pull_request: | |
| branches: | |
| - "**" | |
| schedule: | |
| - cron: "0 4 * * *" # run every day at 4am UTC | |
| defaults: | |
| run: | |
| shell: bash | |
| concurrency: | |
| group: ${{ github.ref_name }}-ci | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| jobs: | |
| vars: | |
| name: Checks and variables | |
| runs-on: ubuntu-24.04 | |
| outputs: | |
| go_path: ${{ steps.vars.outputs.go_path }} | |
| min_k8s_version: ${{ steps.vars.outputs.min_k8s_version }} | |
| k8s_latest: ${{ steps.vars.outputs.k8s_latest }} | |
| helm_changes: ${{ steps.filter.outputs.charts }} | |
| docs_only_changes: ${{ steps.filter.outputs.docs && !steps.filter.outputs.code }} | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| fetch-depth: 0 | |
| token: ${{ github.actor == 'renovate[bot]' && secrets.NGINX_PAT || github.token }} | |
| - name: Setup Golang Environment | |
| uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0 | |
| with: | |
| go-version: stable | |
| cache-dependency-path: | | |
| go.sum | |
| .github/.cache/buster-for-vars | |
| - name: Check for changes | |
| uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2 | |
| id: filter | |
| with: | |
| filters: | | |
| charts: | |
| - charts/nginx-gateway-fabric/**/* | |
| docs: &docs | |
| - design/** | |
| - docs/** | |
| - examples/** | |
| - site/** | |
| code: | |
| - '**' | |
| - '!*docs' | |
| - name: Output Variables | |
| id: vars | |
| run: | | |
| K8S_KIND_VERSION=v1.32.0 # renovate: datasource=docker depName=kindest/node | |
| echo "go_path=$(go env GOPATH)" >> $GITHUB_OUTPUT | |
| echo "min_k8s_version=v1.25.16" >> $GITHUB_OUTPUT | |
| echo "k8s_latest=${K8S_KIND_VERSION}" >> $GITHUB_OUTPUT | |
| - name: Check if go.mod and go.sum are up to date | |
| run: go mod tidy && git diff --exit-code -- go.mod go.sum | |
| - name: Check if go.mod and go.sum are up to date in tests | |
| run: go mod tidy && git diff --exit-code -- go.mod go.sum | |
| working-directory: tests | |
| - name: Check if all the generated files are up to date | |
| run: make generate-all && git diff --exit-code | |
| unit-tests: | |
| name: Unit Tests | |
| runs-on: ubuntu-24.04 | |
| needs: vars | |
| if: ${{ needs.vars.outputs.docs_only_changes == 'true' }} | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Setup Golang Environment | |
| uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0 | |
| with: | |
| go-version: stable | |
| cache-dependency-path: | | |
| go.sum | |
| .github/.cache/buster-for-unit-tests | |
| - name: Run Tests | |
| run: make unit-test | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@1e68e06f1dbfde0e4cefc87efeba9e4643565303 # v5.1.2 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| - name: Upload Coverage Report | |
| uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 | |
| with: | |
| name: cover-${{ github.run_id }}.html | |
| path: ${{ github.workspace }}/cover.html | |
| if: always() | |
| njs-unit-tests: | |
| name: NJS Unit Tests | |
| runs-on: ubuntu-24.04 | |
| needs: vars | |
| if: ${{ needs.vars.outputs.docs_only_changes == 'true' }} | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Setup Node.js Environment | |
| uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0 | |
| with: | |
| node-version-file: .nvmrc | |
| - name: Run tests | |
| run: npm --prefix ${{ github.workspace }}/internal/mode/static/nginx/modules install-ci-test | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@1e68e06f1dbfde0e4cefc87efeba9e4643565303 # v5.1.2 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| binary: | |
| name: Build Binary | |
| runs-on: ubuntu-24.04 | |
| needs: [vars, unit-tests, njs-unit-tests] | |
| permissions: | |
| contents: write # for goreleaser/goreleaser-action and lucacome/draft-release to create/update releases | |
| id-token: write # for goreleaser/goreleaser-action to sign artifacts | |
| issues: write # for goreleaser/goreleaser-action to close milestone | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Golang Environment | |
| uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0 | |
| with: | |
| go-version: stable | |
| cache-dependency-path: | | |
| go.sum | |
| .github/.cache/buster-for-binary | |
| - name: Create/Update Draft | |
| uses: lucacome/draft-release@5d29432a46bff6c122cd4b07a1fb94e1bb158d34 # v1.1.1 | |
| with: | |
| minor-label: "enhancement" | |
| major-label: "change" | |
| publish: ${{ github.ref_type == 'tag' }} | |
| collapse-after: 20 | |
| notes-header: | | |
| *Below is the auto-generated changelog, which includes all PRs that went into the release. | |
| For a shorter version that highlights only important changes, see [CHANGELOG.md](https://github.com/nginxinc/nginx-gateway-fabric/blob/{{version}}/CHANGELOG.md).* | |
| if: ${{ github.event_name == 'push' && github.ref != 'refs/heads/main' }} | |
| - name: Download Syft | |
| uses: anchore/sbom-action/download-syft@df80a981bc6edbc4e220a492d3cbe9f5547a6e75 # v0.17.9 | |
| if: github.ref_type == 'tag' | |
| - name: Install Cosign | |
| uses: sigstore/cosign-installer@dc72c7d5c4d10cd6bcb8cf6e3fd625a9e5e537da # v3.7.0 | |
| if: github.ref_type == 'tag' | |
| - name: Build binary | |
| uses: goreleaser/goreleaser-action@9ed2f89a662bf1735a48bc8557fd212fa902bebf # v6.1.0 | |
| with: | |
| version: v2.5.0 # renovate: datasource=github-tags depName=goreleaser/goreleaser | |
| args: ${{ github.ref_type == 'tag' && 'release' || 'build --snapshot' }} --clean | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GOPATH: ${{ needs.vars.outputs.go_path }} | |
| AZURE_STORAGE_ACCOUNT: ${{ secrets.AZURE_STORAGE_ACCOUNT }} | |
| AZURE_STORAGE_KEY: ${{ secrets.AZURE_STORAGE_KEY }} | |
| AZURE_BUCKET_NAME: ${{ secrets.AZURE_BUCKET_NAME }} | |
| SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_COMMUNITY }} | |
| TELEMETRY_ENDPOINT: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/heads/release-') && 'oss-dev.edge.df.f5.com:443' || 'oss.edge.df.f5.com:443' }} | |
| TELEMETRY_ENDPOINT_INSECURE: "false" | |
| - name: Cache Artifacts | |
| uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0 | |
| with: | |
| path: ${{ github.workspace }}/dist | |
| key: nginx-gateway-fabric-${{ github.run_id }}-${{ github.run_number }} | |
| build-oss: | |
| name: Build OSS images | |
| needs: [vars, binary] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| image: [ngf, nginx] | |
| platforms: ["linux/arm64, linux/amd64"] | |
| uses: ./.github/workflows/build.yml | |
| with: | |
| image: ${{ matrix.image }} | |
| platforms: ${{ matrix.platforms }} | |
| permissions: | |
| contents: read # for docker/build-push-action to read repo content | |
| security-events: write # for github/codeql-action/upload-sarif to upload SARIF results | |
| packages: write # for docker/build-push-action to push to GHCR | |
| id-token: write # for docker/login to login to NGINX registry | |
| secrets: inherit | |
| build-plus: | |
| name: Build Plus images | |
| needs: [vars, binary] | |
| uses: ./.github/workflows/build.yml | |
| with: | |
| image: plus | |
| platforms: "linux/arm64, linux/amd64" | |
| permissions: | |
| contents: read # for docker/build-push-action to read repo content | |
| security-events: write # for github/codeql-action/upload-sarif to upload SARIF results | |
| packages: write # for docker/build-push-action to push to GHCR | |
| id-token: write # for docker/login to login to NGINX registry | |
| secrets: inherit | |
| functional-tests: | |
| name: Functional tests | |
| needs: [vars, build-oss, build-plus] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| image: [nginx, plus] | |
| k8s-version: | |
| [ | |
| "${{ needs.vars.outputs.min_k8s_version }}", | |
| "${{ needs.vars.outputs.k8s_latest }}", | |
| ] | |
| uses: ./.github/workflows/functional.yml | |
| with: | |
| image: ${{ matrix.image }} | |
| k8s-version: ${{ matrix.k8s-version }} | |
| secrets: inherit | |
| permissions: | |
| contents: read | |
| conformance-tests: | |
| name: Conformance tests | |
| needs: [vars, build-oss, build-plus] | |
| if: ${{ ! failure() }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| image: [nginx, plus] | |
| k8s-version: | |
| [ | |
| "${{ needs.vars.outputs.min_k8s_version }}", | |
| "${{ needs.vars.outputs.k8s_latest }}", | |
| ] | |
| enable-experimental: [true, false] | |
| uses: ./.github/workflows/conformance.yml | |
| with: | |
| image: ${{ matrix.image }} | |
| k8s-version: ${{ matrix.k8s-version }} | |
| enable-experimental: ${{ matrix.enable-experimental }} | |
| if: ${{ (!github.event.pull_request.head.repo.fork || matrix.image != 'plus' ) && needs.vars.outputs.docs_only_changes != 'true' }} | |
| secrets: inherit | |
| permissions: | |
| contents: write | |
| helm-tests: | |
| name: Helm Tests | |
| needs: [vars, build-oss, build-plus] | |
| if: ${{ needs.vars.outputs.helm_changes == 'true' || github.event_name == 'schedule' }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| image: [nginx, plus] | |
| k8s-version: | |
| [ | |
| "${{ needs.vars.outputs.min_k8s_version }}", | |
| "${{ needs.vars.outputs.k8s_latest }}", | |
| ] | |
| uses: ./.github/workflows/helm.yml | |
| with: | |
| image: ${{ matrix.image }} | |
| k8s-version: ${{ matrix.k8s-version }} | |
| secrets: inherit | |
| publish-helm: | |
| name: Package and Publish Helm Chart | |
| runs-on: ubuntu-24.04 | |
| needs: [vars, helm-tests] | |
| if: ${{ github.event_name == 'push' && ! startsWith(github.ref, 'refs/heads/release-') }} | |
| permissions: | |
| contents: read | |
| packages: write # for helm to push to GHCR | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Login to GitHub Container Registry | |
| uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.repository_owner }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Package | |
| id: package | |
| run: | | |
| output=$(helm package ${{ github.ref_type != 'tag' && '--app-version edge --version 0.0.0-edge' || '' }} charts/nginx-gateway-fabric) | |
| echo "path=$(basename -- $(echo $output | cut -d: -f2))" >> $GITHUB_OUTPUT | |
| - name: Push to GitHub Container Registry | |
| run: | | |
| helm push ${{ steps.package.outputs.path }} oci://ghcr.io/nginxinc/charts |