summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVille Skyttä <ville.skytta@iki.fi>2023-02-09 11:24:49 +0200
committerGitHub <noreply@github.com>2023-02-09 09:24:49 +0000
commit891625366a636a68404ed4089fa0b792538cf5f6 (patch)
tree9c3c6a3c199d779bad10aff38d99905c0b5d4be0
parentf5ef2ee9e7f5b9bbff2aaaa3f1fae45994864ee9 (diff)
Docs: example fixes (#433)
* Use same placeholder `rev` comment for both pre-commit examples * Fix `--commits` special references example
-rw-r--r--docs/index.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/index.md b/docs/index.md
index b79f8d6..b735b6b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -272,7 +272,7 @@ If you want to lint more commits you can modify the `gitlint-ci` hook like so:
```yaml
- repo: https://github.com/jorisroovers/gitlint
- rev: v0.17.0
+ rev: # insert ref, e.g. v0.18.0
hooks:
- id: gitlint
- id: gitlint-ci
@@ -318,7 +318,7 @@ gitlint --commits mybranch
# Lint all commits that are different between a branch and your main branch
gitlint --commits "main..mybranch"
# Use git's special references
-gitlint --commits "origin..HEAD"
+gitlint --commits "origin/main..HEAD"
# You can also pass multiple, comma separated commit hashes:
gitlint --commits 019cf40,c50eb150,d6bc75a