| icon |
|---|
square-terminal |
Aviator is a suite of productivity tools purpose-built to reduce friction in development workflows. av is an open-source CLI built and managed by Aviator to interact with GitHub and Aviator service. The primary use case is creating and managing Stacked PRs.
{% embed url="https://youtu.be/xSopIrkf2KM" %} Managing stacked PRs using Aviator CLI {% endembed %}
{% hint style="info" %} The Stacked PRs CLI does not require creating an Aviator account and can be installed directly. {% endhint %}
Stacked PRs are useful when you have a lot of code changes that are hard to review in a single PR. Stacked PRs let you break down the changes into smaller PRs that are "stacked" on top of each other, keeping code review manageable. This means you can keep working on the next bit of code related to a feature even while waiting for your previous PR(s) to pass CI, be approved, and merged!
For example, if PR1 is Add the /books/list route to the backend and PR2 is Show the books list in the frontend, we can stack PR2 on top of PR1. This means that you don’t have to wait for PR1 to be reviewed and merged before you can start PR2 (and they can even be reviewed by separate people!).
Learn more about the cultural implication of using Stacked PRs in our blog post.
You don’t need an Aviator account to start using the CLI. You can simply install the CLI using your OS package manager. For instance, on Mac you can use Homebrew:
brew install aviator-co/tap/av
For installation on other platforms or step by step guide, please checkout installation instructions.
av CLI needs a GitHub credential for creating and updating PRs. Install GitHub CLI, and av CLI will use the same credential for interacting with GitHub. Alternatively, you can use a GitHub Personal Access Token. See create-a-user-access-token.md.
Finally, initialize the repository so that CLI can start tracking your active branches.
av init
Creating the first branch in the stack is just the same as creating any normal branch in your repository, except now you use the av CLI. The av stack branch command requires one argument which is the name of the branch to create. This command will create a branch on top of the current branch.
# Create a new branch off of your repository default branch
# (usually main or master)
av stack branch "bookstore-backend"
# Now we can do our development work as normal.
mkdir ./books
echo '...' >> ./books/backend.py
git add ./books
git commit -m "Add /books/list route to backend"
To create the PR, also use the av pr create command to ensure that the correct base branch is set in the PR.
av pr create
For the next branch, we use the av stack branch command again, except this time we're branching from bookstore-backend instead of main since we want to build off of our previous work. Behind the scenes, the CLI sets some internal data to be able to recognize that bookstore-frontend is dependent on bookstore-backend.
av stack branch "bookstore-frontend"
And when it comes time to submit our work as PR, we use the av pr create command again.
When creating this PR, the CLI again automatically sets the base branch in GitHub as bookstore-backend rather than main to ensure that GitHub shows the diff between bookstore-frontend and bookstore-backend. Otherwise, it would show all the changes from bookstore-backend in the PR for bookstore-frontend which would make code review much harder.
Already have git branches created? Take a look at adopt-a-branch.md.
Since stacked PRs are designed to make code review easier and more incremental, it's likely that you'll need to change code that you wrote earlier in the stack. The av stack sync command is used to make sure every branch is up-to-date with its stack parent.
To edit a branch that is part of a stack, first we need to check it out.
git checkout bookstore-backend
Then, we can make edits and commit as usual.
echo '...' >> ./books/backend.py
git add ./books
git commit -m "Fix 500 error on malformed input"
Finally, we can run av stack sync to propagate the changes to all children branches.
av stack sync
Merging a stack with Aviator is a little different than merging a non-stacked PR. Although you can merge PRs now manually one at a time, the best way to merge the PRs is to use Aviator MergeQueue.
Aviator MergeQueue is purpose built as a highly scalable stack-aware merge queue. Follow these steps to connect the CLI with Aviator:
- sign up for a free account with Aviator
- walk through the initial steps, and install the Aviator app on GitHub
- navigate to user access token page: https://app.aviator.co/account/apitoken
- generate a token and add it to your configuration file at
~/.av/config.yaml
{% code title="~/.av/config.yaml" lineNumbers="true" %}
aviator:
apiToken: "av_uat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"{% endcode %}
With that, now to merge a partial or full stack, just queue the top most PR of the stack that you would like to merge:
av pr queue
After this, Aviator will automatically validate the changes in the stack, and merge all the changes to the target branch (typically main or master). At any time, you can also review the state of your PR using av pr status.
Aviator also publishes man pages, that you can read for more details on the commands:
man av-stack-sync
In addition, all commands also provide in-line help:
$ av stack help
managed stacked pull requests
Usage:
av stack [command]
Aliases:
stack, st
Available Commands:
adopt Adopt branches
branch create a new stacked branch
branch-commit create a new stacked branch and commit staged changes to it
diff generate diff between working tree and the parent branch
for-each execute a command for each branch in the current stack
next checkout the next branch in the stack
orphan Current branch and the child branches will be orphaned
prev checkout the previous branch in the stack
reorder reorder the stack
reparent Reparent branches
restack Restack branches
submit Create pull requests for every branch in the stack
switch switch to a different branch
sync Synchronize stacked branches
tidy Tidy stacked branches
tree show the tree of stacked branches
Flags:
-h, --help help for stack
Global Flags:
--debug enable verbose debug logging
-C, --repo string directory to use for git repository
Use "av stack [command] --help" for more information about a command.
This is just a quick preview of things you can do with the Aviator CLI. Check our our how to guides for more specific use cases:
- Split and fold branches
- Adopt a branch that was created without av
- Navigating the stack
- Renaming a branch
- Setting up auto-complete
\