Documentation
¶
Overview ¶
Package main implements a tool for automatically updating component versions for use in the hack/* scripts.
Files interacted with:
- The source-of-truth file at hack/component-versions.json
- Autogenerated script at hack/component-versions.sh
USAGE:
This is running on semi-auto basis where versions are being auto bumped via PRs sent to main. Semi-auto because if repo is missing 'owner' or 'repo' fields in the .json it will not be automatically bumped (it has no repo to look). This is intentional for components we dont want autobumped like this. The source-of-truth file is found in this repo @root/hack/component-versions.json
ADD NEW/MODIFY COMPONENTS
- Edit source-of-truth .json file ! If a component is missing "owner" or "repo" it will not be auto-bumped
- If new component was added: - Edit the autogenerated text just below here 'versionsScriptTemplate'
- Regenerate using Makefile - find target 'hack-generate-components'
Click to show internal directories.
Click to hide internal directories.