mirror of
https://github.com/git-chglog/git-chglog.git
synced 2026-01-22 18:06:11 +00:00
9a0d584745
When attempting to render a commit body below the summary line of the commit there are two problems: 1) The text needs to be indented two spaces to appear as part of the list. 2) Notes (e.g. BREAKING CHANGE) are included in the body and end up being repeating in a Notes section (if this is part of your template). To address #1 add an `indent` func to the template parsing. To address #2 add a `TrimmedBody` to the `Commit` fields. The `TrimmedBody` will include everything in `Body` but not any `Ref`s, `Note`s, `Mention`s, `CoAuthors`, or `Signers`. Both the CoAuthors and Signers are now first class in the Commit struct. With both of these a template block like: ``` {{ if .TrimmedBody -}} {{ indent .TrimmedBody 2 }} {{ end -}} ``` Will render the trimmed down body section as intended. See TestGeneratorWithTimmedBody for example of desired output.
133 lines
3.2 KiB
Go
133 lines
3.2 KiB
Go
package chglog
|
|
|
|
import "time"
|
|
|
|
// Hash of commit
|
|
type Hash struct {
|
|
Long string
|
|
Short string
|
|
}
|
|
|
|
// Contact of co-authors and signers
|
|
type Contact struct {
|
|
Name string
|
|
Email string
|
|
}
|
|
|
|
// Author of commit
|
|
type Author struct {
|
|
Name string
|
|
Email string
|
|
Date time.Time
|
|
}
|
|
|
|
// Committer of commit
|
|
type Committer struct {
|
|
Name string
|
|
Email string
|
|
Date time.Time
|
|
}
|
|
|
|
// Merge info for commit
|
|
type Merge struct {
|
|
Ref string
|
|
Source string
|
|
}
|
|
|
|
// Revert info for commit
|
|
type Revert struct {
|
|
Header string
|
|
}
|
|
|
|
// Ref is abstract data related to commit. (e.g. `Issues`, `Pull Request`)
|
|
type Ref struct {
|
|
Action string // (e.g. `Closes`)
|
|
Ref string // (e.g. `123`)
|
|
Source string // (e.g. `owner/repository`)
|
|
}
|
|
|
|
// Note of commit
|
|
type Note struct {
|
|
Title string // (e.g. `BREAKING CHANGE`)
|
|
Body string // `Note` content body
|
|
}
|
|
|
|
// NoteGroup is a collection of `Note` grouped by titles
|
|
type NoteGroup struct {
|
|
Title string
|
|
Notes []*Note
|
|
}
|
|
|
|
// JiraIssue is information about a jira ticket (type, summary, description, and labels)
|
|
type JiraIssue struct {
|
|
Type string
|
|
Summary string
|
|
Description string
|
|
Labels []string
|
|
}
|
|
|
|
// Commit data
|
|
type Commit struct {
|
|
Hash *Hash
|
|
Author *Author
|
|
Committer *Committer
|
|
Merge *Merge // If it is not a merge commit, `nil` is assigned
|
|
Revert *Revert // If it is not a revert commit, `nil` is assigned
|
|
Refs []*Ref
|
|
Notes []*Note
|
|
Mentions []string // Name of the user included in the commit header or body
|
|
CoAuthors []Contact // (e.g. `Co-authored-by: user <user@email>`)
|
|
Signers []Contact // (e.g. `Signed-off-by: user <user@email>`)
|
|
JiraIssue *JiraIssue // If no issue id found in header, `nil` is assigned
|
|
Header string // (e.g. `feat(core)[RNWY-310]: Add new feature`)
|
|
Type string // (e.g. `feat`)
|
|
Scope string // (e.g. `core`)
|
|
Subject string // (e.g. `Add new feature`)
|
|
JiraIssueID string // (e.g. `RNWY-310`)
|
|
Body string
|
|
TrimmedBody string // Body without any Notes/Refs/Mentions/CoAuthors/Signers
|
|
}
|
|
|
|
// CommitGroup is a collection of commits grouped according to the `CommitGroupBy` option
|
|
type CommitGroup struct {
|
|
RawTitle string // Raw title before conversion (e.g. `build`)
|
|
Title string // Conversion by `CommitGroupTitleMaps` option, or title converted in title case (e.g. `Build`)
|
|
Commits []*Commit
|
|
}
|
|
|
|
// RelateTag is sibling tag data of `Tag`.
|
|
// If you give `Tag`, the reference hierarchy will be deepened.
|
|
// This struct is used to minimize the hierarchy of references
|
|
type RelateTag struct {
|
|
Name string
|
|
Subject string
|
|
Date time.Time
|
|
}
|
|
|
|
// Tag is data of git-tag
|
|
type Tag struct {
|
|
Name string
|
|
Subject string
|
|
Date time.Time
|
|
Next *RelateTag
|
|
Previous *RelateTag
|
|
}
|
|
|
|
// Version is a tag-separeted datset to be included in CHANGELOG
|
|
type Version struct {
|
|
Tag *Tag
|
|
CommitGroups []*CommitGroup
|
|
Commits []*Commit
|
|
MergeCommits []*Commit
|
|
RevertCommits []*Commit
|
|
NoteGroups []*NoteGroup
|
|
}
|
|
|
|
// Unreleased is unreleased commit dataset
|
|
type Unreleased struct {
|
|
CommitGroups []*CommitGroup
|
|
Commits []*Commit
|
|
MergeCommits []*Commit
|
|
RevertCommits []*Commit
|
|
NoteGroups []*NoteGroup
|
|
}
|