diff options
author | Joris Roovers <joris.roovers@gmail.com> | 2019-08-16 14:30:19 +0200 |
---|---|---|
committer | Joris Roovers <joris.roovers@gmail.com> | 2019-08-17 14:18:52 +0200 |
commit | b91bed5257bff42b1f2c30b3bc6d0cd0da69ee3b (patch) | |
tree | b07bb06b81a108bc07a9a443b466cf24ca6d320d /docs | |
parent | 2f192852929b0d7b6d48c8d2b4d36f825bd05aa6 (diff) |
Commit revert detection
Gitlint can now detect whether a commit is a revert commit. Rules can
use this information during linting.
Also updated debug output to print more meta information.
Relates to #99.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/user_defined_rules.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/user_defined_rules.md b/docs/user_defined_rules.md index 04e1c36..b33f7da 100644 --- a/docs/user_defined_rules.md +++ b/docs/user_defined_rules.md @@ -171,6 +171,9 @@ commit.author_name | string | Name of the author, result of ```git commit.author_email | string | Email of the author, result of ```git log --pretty=%aE``` commit.date | datetime | Python ```datetime``` object representing the time of commit commit.is_merge_commit | boolean | Boolean indicating whether the commit is a merge commit or not. +commit.is_revert_commit | boolean | Boolean indicating whether the commit is a revert commit or not. +commit.is_fixup_commit | boolean | Boolean indicating whether the commit is a fixup commit or not. +commit.is_squash_commit | boolean | Boolean indicating whether the commit is a squash commit or not. commit.parents | list of string | List of parent commit ```sha```s (only for merge commits). commit.changed_files | list of string | List of files changed in the commit (relative paths). commit.context | object | Object pointing to the bigger git context that the commit is part of |