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

Generate action READMEs from the YAML #137

Open
jdbaldry opened this issue May 31, 2024 · 0 comments
Open

Generate action READMEs from the YAML #137

jdbaldry opened this issue May 31, 2024 · 0 comments

Comments

@jdbaldry
Copy link
Member

I don't trust that any of the READMEs' inputs and outputs match the actual action specification.

I think a quick tool that generates the READMEs from a template that can be used for all actions would be better than relying on maintainers and contributors to keep the two in sync. Of course, CI should enforce that the README matches the action. We could even add an additional workflow that regenerates the READMEs on a branch so that it doesn't need to be performed locally.

I understand that READMEs help with discoverability so I'm not sure that it's justified to remove them in the mean time.

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

No branches or pull requests

1 participant