You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-9
Original file line number
Diff line number
Diff line change
@@ -127,7 +127,7 @@ COMMAND SUPPLIED
127
127
128
128
### 1. Export a valid Github token
129
129
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.
@@ -232,8 +232,6 @@ If you want the tool to find and select every repo in your Github organization,
232
232
```
233
233
./git-xargs \
234
234
--commit-message "Update copyright year" \
235
-
--pull-request-title "Update copyright year" \
236
-
--pull-request-description "Update the year to 2021" \
237
235
--github-org <your-github-org> \
238
236
"$(pwd)/scripts/update-copyright-year.sh"
239
237
```
@@ -247,8 +245,6 @@ Oftentimes, you want finer-grained control over the exact repos you are going to
247
245
```
248
246
./git-xargs \
249
247
--commit-mesage "Update copyright year" \
250
-
--pull-request-title "Update copyright year" \
251
-
--pull-request-description "Update the year to 2021" \
252
248
--repos data/batch2.txt \
253
249
"$(pwd)/scripts/update-copyright-year.sh"
254
250
```
@@ -274,10 +270,7 @@ Flat files contain one repo per line, each repository in the format of `<github-
274
270
|`--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 |
275
271
|`--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 |
276
272
| `--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 |
281
274
|`--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 |
282
275
|`--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 |
0 commit comments