Skip to content

Commit e6a26c4

Browse files
authored
Update README.md (#1)
1 parent 9428348 commit e6a26c4

File tree

1 file changed

+2
-9
lines changed

1 file changed

+2
-9
lines changed

README.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ COMMAND SUPPLIED
127127

128128
### 1. Export a valid Github token
129129

130-
See [Github personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) for information on how to generate one.
130+
See the guide on [Github personal access tokens](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) for information on how to generate one.
131131

132132
```
133133
export GITHUB_OAUTH_TOKEN=<your-secret-github-oauth-token>
@@ -232,8 +232,6 @@ If you want the tool to find and select every repo in your Github organization,
232232
```
233233
./git-xargs \
234234
--commit-message "Update copyright year" \
235-
--pull-request-title "Update copyright year" \
236-
--pull-request-description "Update the year to 2021" \
237235
--github-org <your-github-org> \
238236
"$(pwd)/scripts/update-copyright-year.sh"
239237
```
@@ -247,8 +245,6 @@ Oftentimes, you want finer-grained control over the exact repos you are going to
247245
```
248246
./git-xargs \
249247
--commit-mesage "Update copyright year" \
250-
--pull-request-title "Update copyright year" \
251-
--pull-request-description "Update the year to 2021" \
252248
--repos data/batch2.txt \
253249
"$(pwd)/scripts/update-copyright-year.sh"
254250
```
@@ -274,10 +270,7 @@ Flat files contain one repo per line, each repository in the format of `<github-
274270
| `--repos` | If you want to specify many repos and manage them in files (which makes batching and testing easier) then use this flag to pass the filepath to a repos file. See [the repos file format](#option-2-flat-file-of-repository-names) for more information | String | No |
275271
| `--repo` | Use this flag to specify a single repo, e.g., `--repo gruntwork-io/cloud-nuke`. Can be passed multiple times to target several repos | String | No |
276272
| `--github-org` | If you want to target every repo in a Github org that your GITHUB_OAUTH_TOKEN has access to, pass the name of the Organization with this flag, to page through every repo via the Github API and target it | String | No
277-
| `--commit-message` | The commit message to use when creating commits. If you
278-
supply this flag, but neither the optional `--pull-request-title` or
279-
`--pull-request-description` flags, then the commit message will be used for
280-
all three. | String | No |
273+
| `--commit-message` | The commit message to use when creating commits. If you supply this flag, but neither the optional `--pull-request-title` or `--pull-request-description` flags, then the commit message value will be used for all three. | String | No |
281274
| `--skip-pull-requests` | If you don't want any pull requests opened, but would rather have your changes committed directly to your specified branch, pass this flag. Note that it won't work if your Github repo is configured with branch protections on the branch you're trying to commit directly to! | Boolean | No |
282275
| `--dry-run` | If you are in the process of testing out `git-xargs` or your intial set of targeted repos, but you don't want to make any changes via the Github API (pushing your local changes or opening pull requests) you can pass the dry-run branch. This is useful because the output report will still tell you which repos would have been affected, without actually making changes via the Github API to your remote repositories. | Boolean | No |
283276

0 commit comments

Comments
 (0)