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 CI for autogeneration of api docs on push to main #310

Merged
merged 3 commits into from
Jun 11, 2021
Merged

Add CI for autogeneration of api docs on push to main #310

merged 3 commits into from
Jun 11, 2021

Conversation

mahalrs
Copy link
Contributor

@mahalrs mahalrs commented Jun 11, 2021

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.

@mahalrs
Copy link
Contributor Author

mahalrs commented Jun 11, 2021

I tested this CI on a different repository and it works as expected. It commits changes only if there are diffs.

@codecov-commenter
Copy link

codecov-commenter commented Jun 11, 2021

Codecov Report

Merging #310 (abd6b35) into main (e30ea47) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e30ea47...abd6b35. Read the comment docs.

Copy link
Contributor

@nitishm nitishm left a 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 🤞

@nitishm nitishm merged commit a42338d into Azure:main Jun 11, 2021
nitishm added a commit that referenced this pull request Jun 11, 2021
@mahalrs
Copy link
Contributor Author

mahalrs commented Jun 11, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add API docs generation to CI
3 participants