Skip to content

Commit

Permalink
Add CI for autogeneration of api docs on push to main (#310)
Browse files Browse the repository at this point in the history
* Set up docs autogeneration CI

* Delete ./docs/api.md

* Change CI commit message
  • Loading branch information
mahalrs committed Jun 11, 2021
1 parent e30ea47 commit a42338d
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 778 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/generate-api-docs.yaml
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
Loading

0 comments on commit a42338d

Please sign in to comment.