Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "API Docs" GitHub Action to check if docs are up to date #324

Merged
merged 8 commits into from
Jun 15, 2021
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/api-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: API Docs
on:
pull_request:
branches: [main]
push:
branches: [main]

jobs:
check-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Go
uses: actions/setup-go@v2
with:
go-version: '^1.13.1'
- name: gen-crd-api-reference-docs
run: make api-docs
- name: Check if docs are up to date
# This check must fail if there are diffs.
run: git diff --exit-code ./docs/api.md