Quickstart
This page explains how to use Aviator CLI to drive day-to-day development.
Before you begin
Clone your repository locally
Initialize your repository with Aviator CLI
Run av init
inside your repository. You need to do this only once per your local clone.
Create a topic branch
Create a branch with av stack branch BRANCH_NAME
from main
.
The topic branch mytopic
is intended to be merged to main
later. If you want to use other branch as the merge destination, checkout that branch first.
Create a pull-request
Create a pull-request with av pr create
. It shows an editor for the pull-request description. Every time you update your local branch, you can run this to update the pull-request.
Stack a new topic branch
Create a new topic branch on top of the current topic branch with av stack branch
.
You can see the stack with av stack tree
.
Add more changes to the branch.
Create a second pull-request
The second pull-request can be created with av pr create
now.
You can see the pull-request URLs with av stack tree
.
The first pull-request is targeting the main
branch. And the second pull-request is targeting the first pull-request branch.
This will be updated once you merge the first pull-request.
Merge and sync the pull-requests
Let's merge the first pull-request now. We merge the first pull-request and keep the second pull-request open.
After this, we want to make the second one to be rebased on top of the newly updated main
branch. To do this, we run av stack sync --trunk
.
With --trunk
option, it fetches the latest main
from the remote, rebase the second branch on top of it. If you run av stack tree
, you can see that the second branch now has main
as the parent.
We can remove the local branch mytopic
and remove the metadata from av
.
What's next
Last updated