Skip to content

Commit

Permalink
docs: update README for turbolift clone usage
Browse files Browse the repository at this point in the history
Updated the README to clarify the usage of the `turbolift clone` command.
  • Loading branch information
sledigabel committed Oct 22, 2024
1 parent 706c3fb commit e83236d
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Making changes with turbolift is split into six main phases:

1. `init` - getting set up
2. Identifying the repos to operate upon
3. Running a mass `clone` of the repos (by default, it will create a fork in your user space)
3. Running a mass `clone` of the repos
4. Making changes to every repo
5. Committing changes to every repo
6. Creating a PR for every repo
Expand Down Expand Up @@ -115,15 +115,17 @@ turbolift foreach --repos repoFile1.txt -- sed 's/pattern1/replacement1/g'
turbolift foreach --repos repoFile2.txt -- sed 's/pattern2/replacement2/g'
```


### Running a mass `clone`

```turbolift clone```
`turbolift clone` clones all repositories listed in the `repos.txt` file into the `work` directory.
By default the cloning policy is to create a branch to the target repository. If you do not have permissions to push a branch on the target repository, `turbolift` will fork it.

This creates a fork and clones all repositories listed in the `repos.txt` file (or the specified alternative repo file) into the `work` directory.
You may wish to skip the fork and work on the upstream repository branch directly with the flag `--no-fork`.
If you do want to fork all the repositories instead of letting turbolift deciding for you, use the `--fork` flag.

> NTLD: if one of the repositories in the list requires a fork to create a PR, omit the `--no-fork` flag and let all the repositories be forked. For now it's a all-or-nothing scenario.
Usage:
```console
turbolift clone
```

### Making changes

Expand Down

0 comments on commit e83236d

Please sign in to comment.