Commit Context

This is the context structure for each commit in the templates

Name	Type	Description
sha	string	The full hex SHA of the commit.
short_sha	string	The first seven characters of the hex sha.
commit_datetime	datetime	The date and time of the commit with timezone offset.
summary	string	The first line of the commit message.
body	string	The commit message sans the first line.
committer	string	The name and email of the committer as name <email@ex.com>.
authors	list of dict with name and email keys	A list of authors’ names and emails related to the commit. This will always contain the committer. If the ParseTrailers Action was configured in the body_pipeline (the default), this will also include names and emails of people included in the commit trailers as configured via valid_author_tokens.
author_names	list of string	A list of just author names, extracted from authors.
grouping	tuple	The values to group this commit based on the group_by configuration.
metadata	dict	Metadata for this commit parsed from the commit message. Metadata is generated from Actions in a Pipeline.

Commit metadata

Name	Type	Availability	Description
category	string	SummaryRegexMatch MetadataMatch	This value is set using the first Action in the commit_classifiers configuration that returns a value.
trailers	dict	ParseTrailers	The git trailers parsed out of the commit body.
issue	list of string	ParseIssue ParseGitHubIssue ParseJiraIssue ParseAzureBoardIssue	A list of issues parsed from the commit.
has_breaking_change	boolean	ParseBreakingChangeFooter ParseConventionalCommit	Indicates this commit has a breaking change. It doesn’t mean that there is a description of the breaking change.
breaking_changes	string	ParseBreakingChangeFooter	Description of breaking changes as parsed from the commit body.
scope	list of string	ParseConventionalCommit	Zero or more scopes parsed from the commit summary.