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

boulder: Make boulder's own code (i.e. outside of external .yaml fiels) self-documentiong re. macros #376

Open
ermo opened this issue Dec 27, 2024 · 0 comments
Labels
type: documentation Improvements or additions to documentation. type: enhancement New feature or request

Comments

@ermo
Copy link
Member

ermo commented Dec 27, 2024

Make it so that each version of boulder is fully self-documenting in terms of supported macros (actions and definitions), by ensuring that:

  • macros have fields where they are defined that contain a non-empty "description" and "example" field (either being empty should be a build-time error).
  • boulder recipe macros can output a human readable and a JSON formatted output of the above.

Some refactoring may be needed, but will ultimately make it so that the canonical documentation for what boulder supports is single-sourced from the boulder version itself.

The relevant source files for this are:

@ermo ermo added type: documentation Improvements or additions to documentation. type: enhancement New feature or request labels Dec 27, 2024
@ermo ermo changed the title boulder: Make src/package.rs and src/build/job/phase.rs self-documentiong re. macros boulder: Make boulder's own code (i.e. outside of external .yaml fiels) self-documentiong re. macros Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation. type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant