Skip to content

Commit ce0f412

Browse files
authored
Merge pull request #544 from salesforce/readme
Minor readme update
2 parents 1fabaf1 + 3e24ec0 commit ce0f412

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -119,27 +119,36 @@ docker run --rm -e git_api_token -e git_api_url \
119119
```
120120

121121
```commandline
122-
usage: dockerfile-image-update [-h] [-o ORG] [-b BRANCH] [-g GHAPI] [-f] [-m M] [-c C] COMMAND ...
122+
usage: dockerfile-image-update [-h] [-l GHAPISEARCHLIMIT] [-o ORG] [-b BRANCH] [-g GHAPI] [-f] [-m M] [-c C] [-e EXCLUDES] [-B B] [-s {true,false}] [-x X] COMMAND ...
123123
124124
Image Updates through Pull Request Automator
125125
126-
optional arguments:
127-
-h, --help show this help message and exit
128-
-o ORG, --org ORG search within specific organization (default: all of github)
129-
-b BRANCH, --branch BRANCH make pull requests for given branch name (default: master)
130-
-g GHAPI, --ghapi GHAPI link to github api; overrides environment variable
131-
-f, --auto-merge NOT IMPLEMENTED / set to automatically merge pull requests if available
132-
-m PULL_REQ_MESSAGE message to provide for pull requests
133-
-c COMMIT_MESSAGE additional commit message for the commits in pull requests
134-
-x IGNORE_IMAGE_STRING comment snippet after FROM instruction for ignoring a child image. Defaults to 'no-dfiu'
126+
named arguments:
127+
-h, --help show this help message and exit
128+
-l GHAPISEARCHLIMIT, --ghapisearchlimit GHAPISEARCHLIMIT
129+
limit the search results for github api (default: 1000)
130+
-o ORG, --org ORG search within specific organization (default: all of github)
131+
-b BRANCH, --branch BRANCH
132+
make pull requests for given branch name (default: master)
133+
-g GHAPI, --ghapi GHAPI
134+
link to github api; overrides environment variable
135+
-f, --auto-merge NOT IMPLEMENTED / set to automatically merge pull requests if available
136+
-m M message to provide for pull requests
137+
-c C additional commit message for the commits in pull requests
138+
-e EXCLUDES, --excludes EXCLUDES
139+
regex of repository names to exclude from pull request generation
140+
-B B additional body text to include in pull requests
141+
-s {true,false}, --skipprcreation {true,false}
142+
Only update image tag store. Skip creating PRs
143+
-x X comment snippet mentioned in line just before FROM instruction for ignoring a child image. Defaults to 'no-dfiu'
135144
136145
subcommands:
137146
Specify which feature to perform
138147
139148
COMMAND FEATURE
149+
parent updates all repositories' Dockerfiles with given base image
140150
all updates all repositories' Dockerfiles
141151
child updates one specific repository with given tag
142-
parent updates all repositories' Dockerfiles with given base image
143152
```
144153

145154
#### The `all` command

0 commit comments

Comments
 (0)