balena-os / balena-supervisor

Balena Supervisor: balena's agent on devices.
https://balena.io
Other
148 stars 63 forks source link

Add Supervisor configurations contract #1670

Open 20k-ultra opened 3 years ago

20k-ultra commented 3 years ago

The goals for this will be to document the configuration values which have been documented in https://github.com/balena-os/balena-supervisor/pull/1648.

This way other processes can easily process the variables and display them however way they want. For example, the docs can have dropdown to select different versions of this contract. Additionally, we could use this to verify documented configurations match what the codebase matches on each PR.

20k-ultra commented 3 years ago

This contract should allow a hidden field to each configuration variable so we can hide a variable we are phasing out but leaving in the source code for backward compatibility.

By using transformers we'll read the source code to generate the contract and push to https://github.com/balena-io/contracts