Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateGoldmark ¶
Creates a new goldmark instance, used to parse Markdown to HTML.
func NewKeepAChangelogParser ¶
func NewOGParser ¶
Types ¶
type ParseResult ¶
type ParseResult struct {
ReleaseNotes []ParsedReleaseNote
HasMore bool
}
type ParsedReleaseNote ¶
func (*ParsedReleaseNote) AddTag ¶
func (a *ParsedReleaseNote) AddTag(t string)
type Parser ¶
type Parser struct {
// contains filtered or unexported fields
}
func NewParser ¶
Creates a new Parser that can be used to parse RawReleaseNote files to ParsedReleaseNote. Converts all Markdown content to HTML.
func (*Parser) Parse ¶
func (p *Parser) Parse(ctx context.Context, raw []source.RawReleaseNote, kPage internal.Pagination) ParseResult
Parses all the raw articles, uses either the keep-a-changelog parser or our og parser. Uses the keep-a-changelog parser if only a single article in the keep-a-changelog format is provided. Pagination is only applied when using the keep-a-changelog parser. Else parses using the original parser.
func (*Parser) ParseRawRelease ¶
func (p *Parser) ParseRawRelease(ctx context.Context, raw source.RawReleaseNote, kPage internal.Pagination) ParseResult
Parses a raw release note, using either the keep-a-changelog parser or our own format og parser. Uses our own og parser if the raw release notes starts with "---". Else uses keep-a-changelog parser. Pagination is only applied when using keep-a-changelog parser.
Source Files