Skip to content

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

Conversation

parthea
Copy link
Contributor

@parthea parthea commented Apr 7, 2021

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/ folder

  • README.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 to allapis.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:

@parthea parthea requested a review from a team as a code owner April 7, 2021 17:58
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Apr 7, 2021
@parthea parthea marked this pull request as draft April 7, 2021 18:25
@parthea parthea changed the title chore: add scripts to update discovery artifacts [WIP] chore: add scripts to update discovery artifacts Apr 7, 2021
@parthea parthea force-pushed the add-scripts-for-updating-discovery-artifacts-using-github-action branch 3 times, most recently from 377735a to a92b5ad Compare April 8, 2021 19:51
@parthea parthea changed the title [WIP] chore: add scripts to update discovery artifacts chore: add scripts to update discovery artifacts Apr 8, 2021
@parthea parthea requested review from busunkim96 and tswast April 8, 2021 19:52
@parthea parthea marked this pull request as ready for review April 8, 2021 19:52
@parthea parthea force-pushed the add-scripts-for-updating-discovery-artifacts-using-github-action branch 2 times, most recently from dfb5856 to dad7255 Compare April 11, 2021 12:22
@parthea
Copy link
Contributor Author

parthea commented Apr 15, 2021

@busunkim96 @tswast This is ready for review. PTAL.

Copy link

@tswast tswast left a 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.

@parthea parthea force-pushed the add-scripts-for-updating-discovery-artifacts-using-github-action branch from 500040b to 8c25e1f Compare April 21, 2021 12:55
@parthea
Copy link
Contributor Author

parthea commented Apr 21, 2021

@tswast All comments have been addressed. PTAL

Copy link

@tswast tswast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@parthea parthea added the automerge Merge the pull request once unit tests and other checks pass. label Apr 21, 2021
@gcf-merge-on-green gcf-merge-on-green bot merged commit aff037a into master Apr 21, 2021
@gcf-merge-on-green gcf-merge-on-green bot deleted the add-scripts-for-updating-discovery-artifacts-using-github-action branch April 21, 2021 15:00
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Apr 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants