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

Explore auto-generating api_version docs #462

Open
drevell opened this issue Feb 27, 2024 · 0 comments
Open

Explore auto-generating api_version docs #462

drevell opened this issue Feb 27, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@drevell
Copy link
Contributor

drevell commented Feb 27, 2024

Context: #461

As an abc maintainer, I want to make sure that all supported api_versions are documented in README.md. We want to avoid a situation where we release an api_version but forget to document it.

Possible solution idea: create a simple Go program that runs during CI. This program will fail the CI process if it detects an undocumented, released api_version. The program will run these steps:

  • Look at the list of releases in decode.go to find the set of released api_versions (the ones with unreleased==false).
  • Look at README.md to find the table that documents each api_version.
  • Make sure each api_version from step 1 has a table row from step 2, and the table row looks like real docs (the table shouldn't just say "unreleased" or "not released yet").
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

1 participant