-
Notifications
You must be signed in to change notification settings - Fork 2.5k
chore: add scripts to update discovery artifacts #1286
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
chore: add scripts to update discovery artifacts #1286
Conversation
377735a
to
a92b5ad
Compare
dfb5856
to
dad7255
Compare
@busunkim96 @tswast This is ready for review. PTAL. |
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.
Looks good! A few nits re: pathlib vs os, but feel free to ignore / stick with os.
500040b
to
8c25e1f
Compare
@tswast All comments have been addressed. PTAL |
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.
Looks good!
These PR add the scripts from #1187 that are needed to update discovery artifacts using a Github action. The scripts will be removed from #1187 once all of the review comments from #1187 have been resolved.
This PR adds the following files under the
scripts/
folderREADME.md
to provide instructions on manually updating discovery artifacts and API reference documentation.buildprbody.py
creates a summary of the changes detected in discovery artifacts and writes them toallapis.summary
.changesummary.py
creates verbose change information for each API with discovery artifact changes.createcommits.sh
creates git commits for each API with discovery artifact changes or reference document changes.updatediscoveryartifacts.py
is the python file that can be used to update discovery artifacts.I also moved
describe.py
under the scripts folder and modified it to save the discovery artifacts that are fetched.TODO: