forked from mirrors/jj
parent
35f11e2cdc
commit
e158423cb0
1 changed files with 65 additions and 8 deletions
|
@ -11,10 +11,17 @@ authenticated http.
|
|||
|
||||
## Basic workflow
|
||||
|
||||
The simplest way to start with Jujutsu is by creating a stack of commits and letting Jujutsu auto-create a branch.
|
||||
The simplest way to start with Jujutsu is to create a stack of commits first.
|
||||
You will only need to create a branch when you need to push the stack to a
|
||||
remote. There are two primary workflows, using a generated branch name or
|
||||
naming a branch.
|
||||
|
||||
### Using a generated branch name
|
||||
|
||||
In this example we're letting Jujutsu auto-create a branch.
|
||||
|
||||
```shell
|
||||
# Start a new commit off of `main`
|
||||
# Start a new commit off of the default branch.
|
||||
$ jj new main
|
||||
# Refactor some files, then add a description and start a new commit
|
||||
$ jj commit -m 'refactor(foo): restructure foo()'
|
||||
|
@ -24,9 +31,26 @@ $ jj commit -m 'feat(bar): add support for bar'
|
|||
$ jj git push -c @-
|
||||
```
|
||||
|
||||
While it's possible to create a branch and commit on top of it in a Git like
|
||||
manner, it's not recommended, as no further commits will be placed on the
|
||||
branch.
|
||||
### Using a named branch
|
||||
|
||||
In this example, we create a branch named `bar` and then push it to the remote.
|
||||
|
||||
```shell
|
||||
# Start a new commit off of the default branch.
|
||||
$ jj new main
|
||||
# Refactor some files, then add a description and start a new commit
|
||||
$ jj commit -m 'refactor(foo): restructure foo()'
|
||||
# Add a feature, then add a description and start a new commit
|
||||
$ jj commit -m 'feat(bar): add support for bar'
|
||||
# Create a branch so we can push it to GitHub
|
||||
$ jj branch create bar -r @- # create a branch `bar` that now contains the previous two commits.
|
||||
# Push the branch to GitHub (pushes only `bar`)
|
||||
$ jj git push
|
||||
```
|
||||
|
||||
While it's possible to create a branch and commit on top of it in a Git-like
|
||||
manner, you will then need to move the branch manually when you create a new
|
||||
commits. Unlike Git, Jujutsu will not do it automatically .
|
||||
|
||||
## Updating the repository.
|
||||
|
||||
|
@ -61,8 +85,8 @@ able to create a branch for a revision.
|
|||
```shell
|
||||
$ # Do your work
|
||||
$ jj commit
|
||||
$ # Jujutsu automatically creates a branch
|
||||
$ jj git push --change $revision
|
||||
$ # Push change "mw", letting Jujutsu automatically create a branch called "push-mwmpwkwknuz"
|
||||
$ jj git push --change mw
|
||||
```
|
||||
|
||||
## Addressing review comments
|
||||
|
@ -88,7 +112,27 @@ $ jj commit -m 'address pr comments'
|
|||
$ # Update the branch to point to the new commit.
|
||||
$ jj branch set your-feature -r @-
|
||||
$ # Push it to your remote
|
||||
$ jj git push.
|
||||
$ jj git push
|
||||
```
|
||||
|
||||
Notably, the above workflow creates a new commit for you. The same can be
|
||||
achieved without creating a new commit.
|
||||
|
||||
> **Warning**
|
||||
> We strongly suggest to `jj new` after the example below, as all further edits
|
||||
> still get amended to the previous commit.
|
||||
|
||||
```shell
|
||||
$ # Create a new commit on top of the `your-feature` branch from above.
|
||||
$ jj new your-feature
|
||||
$ # Address the comments, by updating the code
|
||||
$ jj diff
|
||||
$ # Give the fix a description.
|
||||
$ jj describe -m 'address pr comments'
|
||||
$ # Update the branch to point to the current commit.
|
||||
$ jj branch set your-feature -r @
|
||||
$ # Push it to your remote
|
||||
$ jj git push
|
||||
```
|
||||
|
||||
### Rewriting commits
|
||||
|
@ -111,6 +155,17 @@ $ jj git push --branch your-feature
|
|||
|
||||
The hyphen after `your-feature` comes from [revset](https://github.com/martinvonz/jj/blob/main/docs/revsets.md) syntax.
|
||||
|
||||
## Working with other people's branches
|
||||
|
||||
By default `jj git clone` and `jj git fetch` clone all active branches from
|
||||
the remote. This means that if you want to iterate or test another
|
||||
contributor's branch you can `jj new <branchname>` onto it.
|
||||
|
||||
If your remote has a large amount of old, inactive branches or this feature is
|
||||
undesirable, set `git.auto-local-branch = false` in the config file.
|
||||
|
||||
You can find more information on that setting [here][auto-branch].
|
||||
|
||||
## Using GitHub CLI
|
||||
|
||||
GitHub CLI will have trouble finding the proper git repository path in jj repos
|
||||
|
@ -160,6 +215,8 @@ branches.
|
|||
[^2]: If you're wondering why we prefer clean commits in this project, see
|
||||
e.g. [this blog post][stacked]
|
||||
|
||||
[auto-branch]: config.md#automatic-local-branch-creation
|
||||
|
||||
[detached]: https://git-scm.com/docs/git-checkout#_detached_head
|
||||
|
||||
[gh]: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
|
||||
|
|
Loading…
Reference in a new issue