Auto-generate annotation docs (#11835)

Co-authored-by: Ricardo Katz <rikatz@users.noreply.github.com>
This commit is contained in:
Marco Ebert 2024-08-21 09:38:34 +02:00 committed by GitHub
parent f08a1c4fda
commit 0486f013fe
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 404 additions and 51 deletions

View file

@ -69,6 +69,8 @@ jobs:
baseimage:
- 'NGINX_BASE'
- 'images/nginx-1.25/**'
docs:
- '**/*.md'
test-go:
runs-on: ubuntu-latest
@ -92,6 +94,27 @@ jobs:
- name: Run test
run: make test
verify-docs:
name: Verify Doc generation
runs-on: ubuntu-latest
needs: changes
if: |
(needs.changes.outputs.go == 'true') || (needs.changes.outputs.docs == 'true') || ${{ github.event.workflow_dispatch.run_e2e == 'true' }}
steps:
- name: Checkout
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
- name: Get go version
run: echo "GOLANG_VERSION=$(cat GOLANG_VERSION)" >> $GITHUB_ENV
- name: Set up Go
id: go
uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2
with:
go-version: ${{ env.GOLANG_VERSION }}
check-latest: true
- name: Verify Docs
run: make verify-docs
build:
name: Build
runs-on: ubuntu-latest