-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CI for autogeneration of api docs on push to main (#310)
* Set up docs autogeneration CI * Delete ./docs/api.md * Change CI commit message
- Loading branch information
Showing
2 changed files
with
24 additions
and
778 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
name: Generate API Docs | ||
on: | ||
push: | ||
branches: [main] | ||
|
||
jobs: | ||
gen-docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
- name: gen-crd-api-reference-docs | ||
run: make api-docs | ||
- name: Commit api.md file | ||
run: | | ||
echo ${{ github.ref }} | ||
git add ./docs/api.md | ||
git config --local user.name "github-actions[bot]" | ||
git config --local user.email "<>" | ||
git status | ||
git commit -m "CI: Update api docs" || true | exit 0 | ||
- name: Push changes | ||
if: github.ref == 'refs/heads/main' | ||
run: git push origin main |
Oops, something went wrong.