Is there a way to get branch name in a user-defined rule?

[and-semakin]

By convention in our company we should put Jira ticket ID in the beginning of branch name (for example JIRA-123_do_something_great) and also we should put ticket id in commit message. I would like to check if they are the same. For this I need to get branch name inside of validate method of the rule. But I don't see that there is some property in commit or context objects that would help me. Do I miss something or gitlint is not able to help me in this case?

[jorisroovers]

So gitlint doesn't provide a way to do this out of the box, but I might have a workaround using the non-public gitlint.git._git function.

from gitlint.rules import CommitRule, RuleViolation
from gitlint.options import IntOption
from gitlint.git import _git

class CheckBranchRule(CommitRule):
    name = "branch-name-match-title"
    id = "UC1"

    def validate(self, commit):
        print("title", commit.message.title)

        # See https://stackoverflow.com/a/12142066/381010
        print _git("rev-parse",  "--abbrev-ref", "HEAD")

        # I'll leave the comparison logic to you :-)

        return [RuleViolation(self.id, "Title and branch name don't match", line_nr=1)]

Caveats:

• No guarantees about the availability or workings of the gitlint.git._git function in future gitlint releases, although I think it will remain fairly stable.
• The code above will only work if you're trying to check the latest commit on the branch, it won't work when using gitlint's --commits argument to check multiple commits. This is because a commit might be part of multiple branches, so given a single sha it's not possible to figure out the one branch it's part of. At least not generically - in most cases the commit will only be part of a single branch of course. If you need this, you should still be able to get it to work using git branch --contains commit.sha and some extra parsing and business logic that fits your use-case.

Hope this helps!

[and-semakin]

Thanks for the quick reply @jorisroovers!
Looks reasonable. Will try it :)

Do you have plans to make branch name (or names) accessible via commit or context objects? For example it may be List[str] which will contain one or multiple branch names which commit belongs to.

[jorisroovers]

That did occur to me when writing the reply.
Definitely not opposed to it, it's just a matter of finding/making the time. PRs help - a lot ;-)

[jorisroovers]

Implemented. Will release this as part of the 0.13.0 release, hopefully soon :-)

Also, I think it would be nice to also have a GitContext.current_branch property. Adding that to the plan for 0.14.0 (probably not any time soon).

[jorisroovers]

Released this yesterday as part of the 0.13.0 release - closing this out now :)