Package: revup
Revup provides command-line tools that allow developers to iterate faster on parallel changes and reduce the overhead of creating and maintaining code reviews.FeaturesRevup creates multiple independent chains of branches for you in the background and without touching your working tree. It then creates and manages github pull requests for all those branches.Pull requests target the actual base branch and can be merged manually or by continuous integrationRebase detection saves time and continuous integration cost by not re-pushing if the patch hasn't changedAdds reviewers, labels, and creates drafts all from the commit textAdds auto-updating "review graph" and "patchsets" elements to make pull requests easier to navigaterevup amendandrevup restacksave time by replacing slow rebasesCompatibilityRevup requires python 3.8 or higher and git 2.36 or higher. Revup works with Linux, OSX, and Windows (limited testing).Follow instructionshereto get the latest git version for your OS. Revup uses flags only present in newer git versions.InstallingInstall withpipor your favorite package manager.python3.8-mpipinstallrevupVerify that installation was successful by showing the help page.revup-hYou can also build from source to get the latest updates.git clone https://github.com/Skydio/revup.git && cd revup
make deps && make package && make installTutorialThis tutorial will guide you through using basic revup features.First time setupClone a sandbox repo byforkingrevup, creating anewrepo, or using some other repo you own.
Creating test PRs can be spammy so don't do the tutorial on other people's repos.gitclonehttps://github.com/<your-name>/revup.git&&cdrevupOn first run, you will need to configure github credentials. Create a personal access tokenhereand check the box for "full repo permissions". Revup needs this in order to create and modify pull requests. Then runrevupconfiggithub_oauthand copy and paste the oauth into the prompt.Create independent pull requestsMake your first two commits that will become two separate pull requests.
Note the "Topic:" tag in the commit message - this is what causes revup to recognize and act on a commit.
Each separately named topic will become a new pull request.echomeh>foo;gitaddfoo
gitcommit-m"My first revup foo"-m"Topic: foo"echopeh>bar;gitaddbar
gitcommit-m"My first revup bar"-m"Topic: bar"revupuploadYou've uploaded your first revup changes! Notice how in github, both branches target 'main'. This allows them to be merged independently.Under the hood, revup creates and pushes these branches for you, tracking and managing the dependencies as needed.Create relative pull requestsNow we'll make a new review that's relative to "foo". The "Relative" tag will ensure the new review targets the correct branch.echodeh>>foo;gitaddfoo
gitcommit-m"My second revup foo"-m"Topic: foo2"-m"Relative: foo"revupuploadWith this simple but powerful model, you can upload independent and dependent changes all at once.Multiple commits can be in one topic, in which case they will all be in a single pull request.Commits in the same topic do not need to be adjacent in history.Topics relative to each other do not need to be adjacent in history, but the second topic must come after the first.Modify pull requestsNow let's update a pull request.echoheh>>bar;gitaddbar# EitherrevupamendHEAD~--no-edit# Specify a commit to amend# orrevupamendbar--no-edit# Specify a topic name to amendrevupuploadrevup amendmakes it easy to modify commits in your history. You also have other options for modifying reviews:Adding new commits with the same topicUsinggit rebase --interactivealong withgit commit --amendPulling in upstream changesUsegit pull --rebaseto pull in changes. Don't usegit mergeorgit pullwithout rebase as this creates a merge commit.By default revup will not upload if you pull but haven't made changes to a commit. To override this and upload always, runrevup upload --rebase.[pull]
    rebase = true
[rebase]
    autoStash = trueWe recommend adding the above to.gitconfigto make pulling and rebasing easier.More featuresThis is a non-exhaustive intro to some more handy revup features.For a full description of features, see thedocsor runrevup -horrevup upload -hto view docs inmanformat.Work with forksFor contributing to projects that you may not have push access to, revup can be configured to push to a fork while creating a pull request in the main project.Add git remotes for both the original and fork.$ git remote -v
origin  https://github.com/ORIGINAL_OWNER/REPO_NAME.git (fetch)
origin  https://github.com/ORIGINAL_OWNER/REPO_NAME.git (push)
myfork  https://github.com/YOUR_USERNAME/REPO_NAME.git (fetch)
myfork  https://github.com/YOUR_USERNAME/REPO_NAME.git (push)When uploading, pass the remote to create the pull request in as--remote-nameand the forked remote as--fork-name.revup --remote-name origin --fork-name myfork uploadAdd reviewers / labelsRevup can also add reviewers, assignees, and labels to pull requests. Add the appropriate tags to any commit in a topic.Reviewers: alice, bob
Assignees: eve
Labels: bug, feature, draftGithub usernames can be abbreviated and will match the shortest name with the given prefix.Labels must match exactly. Thedraftlabel is special and will make a pull request a draft if present and unmake draft if removed.Working on other branchesRevup normally auto-detects your local base branch and uses that to list commits and target reviews.
You can choose to target any particular topic to another branch or even multiple branches, in which case revup will use those as the base branch instead (and create multiple pull requests in the latter case).A fix for multiple branches

Topic: fix
Branches: main, rel1.1You can specify base branch on the command line as well, although this is usually not necessary unless you're working on a branch that the autodetector doesn't know about (see Repo config below).revup upload --base-branch custom-branch-nameReview graph and patchsetsRevup will add 2 comments in every pull request to provide helpful features for users and reviewers. These are enabled by default and automatically updated as the pull request changes.The review graph provides links and titles to all local pull requests that have a relative relationship with the current pull request, including any that it depends on, or that depend on it. This allows you to quickly browse between pull requests in a chain.The patchsets table provides a history of uploads for a given pull request as well as links and summaries of the diff between each upload. Notably, revup specially handles
the case where you rebase then upload and will show you a diff with upstream files excluded.Configuring revupRevup is highly configurable using a standard config file format. Every flag is also a config option, so users can get the exact behavior they need.Flags specified on the command line take precedence, followed by config in~/.revupconfig, followed by.revupconfigin the current repo.Repo configThe primary usecase for the in-repo config file is setting up the naming of the main branch and release branches.For example if your main branch ismasterand release branches are named likerel1.1, commit the following to.revupconfigin the repo root.[revup]
main_branch = master
base_branch_globs =
    rel[1-9].[0-9]
    rel[1-9].[0-9][0-9]User configThe user config at~/.revupconfigsaves time by defaulting the most commonly used flags.For example, after getting used to the workflow, a user might not need the confirmation check. Adding the following lines will be the same as running with--skip-confirm.[upload]
skip_confirm = TrueAppendixCommit based development(aka "stacked diffs", "patch based", etc)If you've used tools such as Gerrit, Phabricator, or git mailing lists, you may already be familiar with this style of development. If you'd like to read more, here are some well written discussions on the subject.Stacked Diffs vs Pull RequestIn Praise of Stacked PRsPeer projectsRevup is inspired in part by this non-exhaustive list of open source projects that also support a patch based workflow:ghstack: also a patched based tool integrated with github. revup builds on code from this project, especially graphql usage.git-branchstack: creates branches similar torevup uploadbut doesn't push or create reviews.git-revise: similar torevup amendand the backend for the above with a merge system that handles conflictsContributing & supportThanks for contributing to revup! You can get started with your own idea, or see theissuespage for ideas that other people are excited about.When reporting issues:Check the issue tracker to see if it has already been reported.Provide a description of repro steps.If possible, run the same command withrevup -vto provide verbose logs.DisclaimerRevup is published by Skydio but is not an officially supported Skydio product.