chore(just): organize just recipes into modules and add comments to all #2002
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Leverages justfile's module system to better organize our recipes and adds descriptive and uniform comments to all.
Background
These changes are meant to make the developer local deployment experience easier to understand and use. One primary goal is for
just --list
to provide a more helpful list of recipes. This example shows the new style ofjust deploy
:The oddity of the extra line in the comment is to enforce that single line comments aren't placed to the right of the recipe, which causes formatting problems.
Another goal of these changes is to make the recipes themselves easier to navigate by splitting into submodules and following clear styling throughout (which aids greatly in identifying recipes if one doesn't have
just
syntax highlighting).The final aim of these changes is to make the command line outputs easier to understand by hiding a lot of extraneous information, such as outputs and just recipe calls (automatically listed usually).
Changes
just
directory, containing modulesargo
,clean
,delete
,deploy
,evm
,helm
,init
,kubetail
, andrun
.[doc]
to support multiline comments.@
and summarized withecho
statements.wait-for-*
recipe calls intodeploy
recipes so that they are automatically called when a chart is deployed.Testing
Manually tested all recipes (
deploy::auctioneer
anddeploy::hyperlane-agents
aren't working, but locally they didn't work before, either. I've added "FIXME" to each)Changelogs
No updates required.
Related Issues
closes #1992