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

[ENG-144]: generate buf documentation #768

Merged
merged 6 commits into from
Jul 18, 2022
Merged

Conversation

adisaran64
Copy link
Contributor

Description

  • closes: ENG-144
  • added script to (somewhat) automate the documentation generation process
  • buf documentation has been generated here
  • only evmos proto documentation is shown, third-party dependency docs can be seen by viewing the previous commit to the buf repository (commits come in third_party/evmos_proto pairs)

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

PR review checkboxes:

I have...

  • added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • included the correct type prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link in the PR description to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all required CI checks have passed

Code maintenance:

I have...

  • written unit and integration tests
  • added relevant godoc and code comments.
  • updated relevant documentation (docs/) or specification (x/<module>/spec/)

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • confirmed that this PR does not change production code

@adisaran64 adisaran64 marked this pull request as ready for review July 13, 2022 00:50
Copy link
Contributor

@danburck danburck left a comment

Choose a reason for hiding this comment

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

LGTM. @adisaran64 I don't see when the script is run. Can you add it to update the buf documentation when a PR is merged that changes the proto files?

@adisaran64
Copy link
Contributor Author

@danburck don't think it's possible to automate generating buf documentation, since users need to generate an API token on the website and login to the registry with their username/token after being added to the Evmos organization. only once that's done can the documentation be generated. added build to the other PR though, for when .proto files are changed

@danburck
Copy link
Contributor

Awesome, great work @adisaran64 👏

@danburck danburck enabled auto-merge (squash) July 18, 2022 21:21
@danburck danburck merged commit 9b00b76 into main Jul 18, 2022
@danburck danburck deleted the adisaran64/buf-documentation branch July 18, 2022 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants