Skip to content

Commit f1b23e1

Browse files
author
Matt Pearson
committed
Add docs about '-c' requiring it be first arg.
1 parent ca7cac1 commit f1b23e1

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

deploy.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ set -o errexit #abort if any command fails
33
me=$(basename "$0")
44

55
help_message="\
6-
Usage: $me [<options>]
6+
Usage: $me [-c FILE] [<options>]
77
Deploy generated files to a git branch.
88
99
Options:
@@ -16,7 +16,8 @@ Options:
1616
-n, --no-hash Don't append the source commit's hash to the deploy
1717
commit's message.
1818
-c, --config-file PATH Override default & environment variables' values
19-
with those in set in the file at 'PATH'.
19+
with those in set in the file at 'PATH'. Must be the
20+
first option specified.
2021
2122
Variables:
2223
@@ -81,7 +82,6 @@ parse_args() {
8182

8283
#append commit hash to the end of message by default
8384
append_hash=${GIT_DEPLOY_APPEND_HASH:-true}
84-
8585
}
8686

8787
main() {

readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Do this every time you want to deploy, or have your CI server do it.
3939
### options
4040
`-h`, `--help`: show the program's help info.
4141

42-
`-c`, `--config-file`: specify a file that overrides the script's default configuration, or those values set in `.env`. The syntax for this file should be normal `var=value` declarations.
42+
`-c`, `--config-file`: specify a file that overrides the script's default configuration, or those values set in `.env`. The syntax for this file should be normal `var=value` declarations. __This option _must_ come first on the command-line__.
4343

4444
`-m`, `--message <message>`: specify message to be used for the commit on `deploy_branch`. By default, the message is the title of the source commit, prepended with 'publish: '.
4545

0 commit comments

Comments
 (0)