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

Build protobuf documentation reference during docs release action #622

Merged
merged 2 commits into from
May 4, 2022

Conversation

geel9
Copy link
Member

@geel9 geel9 commented May 4, 2022

Modifies the release-docs GitHub action to build the Protobuf reference markdown file before building and shipping the docs.

Without this step, said Protobuf Reference will only be updated when a developer manually executes devops/generate_proto_files.py and pushes the file to the repo.

Thoughts:

  • Maybe this should only happen when we release a new tagged version of the SDK?
    • Ensures that newer proto files, which haven't been released in the SDK yet, are not documented before they should be.

Copy link
Contributor

@fundthmcalculus fundthmcalculus left a comment

Choose a reason for hiding this comment

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

add pip install -r ./devops/requirements.txt to the previous run action, and this should be good.

@geel9 geel9 merged commit 9bc4f43 into main May 4, 2022
@geel9 geel9 deleted the JC/build-protobuf-docs branch May 4, 2022 18:08
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.

None yet

2 participants