abcxyz / abc

Apache License 2.0
12 stars 3 forks source link

Explore auto-generating api_version docs #462

Open drevell opened 8 months ago

drevell commented 8 months ago

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: