Skip to content

Commit 73f171f

Browse files
committed
document --message and --no-hash
1 parent 16c3ebf commit 73f171f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

readme.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Do this every time you want to deploy, or have your CI server do it.
2222
5. run `./deploy.sh`
2323

2424
### options
25+
`-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: '.
26+
27+
`-n`, `--no-hash`: don't append the hash of the source commit to the commit message on `deploy_branch`. By default, the hash will be appended in a new paragraph, regardless of whether a message was specified with `-m`.
28+
2529
`-v`, `--verbose`: echo expanded commands as they are executed, using the xtrace option. This can be useful for debugging, as the output will include the values of variables that are being used, such as $commit_title and $deploy_directory. However, the script makes special effort to not output the value of $repo, as it may contain a secret authentication token.
2630

2731
`-e`, `--allow-empty`: allow deployment of an empty directory. By default, the script will abort if `deploy_directory` is empty.

0 commit comments

Comments
 (0)