-
Notifications
You must be signed in to change notification settings - Fork 16
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 CI for autogeneration of api docs on push to main #310
Conversation
I tested this CI on a different repository and it works as expected. It commits changes only if there are diffs. |
Codecov Report
@@ Coverage Diff @@
## main #310 +/- ##
=======================================
Coverage 23.40% 23.40%
=======================================
Files 12 12
Lines 782 782
=======================================
Hits 183 183
Misses 592 592
Partials 7 7 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's give it a shot 🤞
Looks like we need to add GITHUB_TOKEN because CI push is getting rejected because it's protected branch. |
Closes #307
This change add CI for generating API docs. The CI will run
make api-docs
and will stage./docs/api.md
file. This file will only be staged if there are diffs. So, the CI is not going to make a commit if there aren't any changes to API docs. The commit user is "github-actions[Bot].I have deleted the
./docs/api.md
file so when merging this PR, CI will generate, commit, and push./docs/api.md
file automatically. In future, this CI will run on every push to main but will commit/push changes only if there are changes to API docs.