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

chore(just): organize just recipes into modules and add comments to all #2002

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ethanoroshiba
Copy link
Contributor

@ethanoroshiba ethanoroshiba commented Feb 26, 2025

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 of just deploy:

Deployment Recipes:

Usage: "just deploy <recipe>"

    # 
    # Deploys cluster, ingress controller, and entire Astria stack, including rollup with
    # Astrotrek and sequencer faucet.
    all
    # 
    # Deploys local Sequencer and Celestia instance.
    # Usage: 
    #   $just deploy astria-local <NAMESPACE> (default: 'astria-dev-cluster')
    astria-local namespace=defaultNamespace
    # 
    # Deploys a local Astrotrek instance.
    astrotrek
    # 
    # Deploys local auctioneer.
    auctioneer
    # 
    # Deploys local EVM Bridge Withdrawer and awaits its readiness.
    bridge-withdrawer
    # 
    # Deploys a local Kubernetes cluster.
    # Usage:
    #   $just deploy cluster <NAMESPACE> <ENABLE_HUBBLE> (defaults: 'astria-dev-cluster', 'false')
    cluster namespace=defaultNamespace enableHubble=hubbleEnabled
    ...

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

  • Added just directory, containing modules argo, clean, delete, deploy, evm, helm, init, kubetail, and run.
  • Added detailed comments to every recipe, using [doc] to support multiline comments.
  • Labeled all key sections and individual recipes with consistent formatting, with a minimum of 2 lines between recipes so that it's easy to distinguish without syntax highlighting.
  • Suppressed command printing in most commands using @ and summarized with echo statements.
  • Moved wait-for-* recipe calls into deploy recipes so that they are automatically called when a chart is deployed.
  • Adjusted all existing just calls in GH workflows accordingly.
  • Adjusted all paths in just recipes accordingly.
  • Reflected changes in READMEs

Testing

Manually tested all recipes (deploy::auctioneer and deploy::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

@github-actions github-actions bot added ci issues that are related to ci and github workflows sequencer-relayer pertaining to the astria-sequencer-relayer crate cd labels Feb 26, 2025
@ethanoroshiba ethanoroshiba added testing charts and removed ci issues that are related to ci and github workflows sequencer-relayer pertaining to the astria-sequencer-relayer crate cd labels Feb 26, 2025
@github-actions github-actions bot added ci issues that are related to ci and github workflows sequencer-relayer pertaining to the astria-sequencer-relayer crate cd labels Feb 26, 2025
@ethanoroshiba ethanoroshiba marked this pull request as ready for review February 26, 2025 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cd charts ci issues that are related to ci and github workflows sequencer-relayer pertaining to the astria-sequencer-relayer crate testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add just recipe comments
1 participant