Skip to content

Commit 2be7ae1

Browse files
authored
mention --head-commit in readme
1 parent 2f4bc18 commit 2be7ae1

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,20 @@ And then execute the pr-checklist runner inside of CI using:
7676
bundle exec pr-checklist.rb -b branch -c tools/deploy_complexity/checklists.rb
7777
```
7878

79+
#### Overriding `HEAD`
80+
81+
deploy-checklist will, by default, treat current `HEAD` as the `HEAD` commit for change tracking.
82+
83+
It's possible to override that behavior like:
84+
85+
```
86+
bundle exec pr-checklist.rb -b branch -c tools/deploy_complexity/checklists.rb --head-commit fafafafa
87+
```
88+
89+
Where `fafafafa` would be used as the `HEAD`.
90+
91+
This is useful if you run deploy-complexity on CI after merging `master` in, for instance. Else, the checklists would report on all incoming changes that are completely unrelated to the branch under analysis.
92+
7993
### Github Token
8094

8195
pr-checklist.rb requires a github token with role REPO to edit PR descriptions and comment on a PR. Make sure that `GITHUB_TOKEN` is set in the environment.

0 commit comments

Comments
 (0)