chglog

Documentation

Index

• Constants
• func NewCli() cli.ActionFunc
• func OpenRepo(repoURL string) *git.Repository
• func ResolveTag(repo *git.Repository, tag string) (*plumbing.Reference, *object.Commit)
• type ArtifactHubChangelogKind
• type ArtifactHubChangelogObject
  • func GenerateChangelogForRepo(from, to, repoURL string, subdirectories []string) []*ArtifactHubChangelogObject
• type ArtifactHubChangelogObjectLinks
• type ArtifactHubChangelogResolverInterface
  • func NewCommitResolver(c *object.Commit, r Resolver) ArtifactHubChangelogResolverInterface
• type ConventionalCommitsResolver
  • func NewConventionalCommitsResolver(c *object.Commit) *ConventionalCommitsResolver
  • func (r *ConventionalCommitsResolver) ResolveChangelogEntry() (*ArtifactHubChangelogObject, error)
• type Resolver

Constants

const (
	StopIteration = "StopIteration"
)

Functions

func NewCli

func NewCli() cli.ActionFunc

func OpenRepo

func OpenRepo(repoURL string) *git.Repository

func ResolveTag

func ResolveTag(repo *git.Repository, tag string) (*plumbing.Reference, *object.Commit)

Types

type ArtifactHubChangelogKind

type ArtifactHubChangelogKind string

const (
	// added, changed, deprecated, removed, fixed and security.
	// https://artifacthub.io/docs/topics/annotations/helm/
	KindAdded      ArtifactHubChangelogKind = "added"
	KindChanged    ArtifactHubChangelogKind = "changed"
	KindDeprecated ArtifactHubChangelogKind = "deprecated"
	KindRemoved    ArtifactHubChangelogKind = "removed"
	KindFixed      ArtifactHubChangelogKind = "fixed"
	KindSecurity   ArtifactHubChangelogKind = "security"
)

type ArtifactHubChangelogObject

type ArtifactHubChangelogObject struct {
	Kind        ArtifactHubChangelogKind          `yaml:"kind"`
	Description string                            `yaml:"description"`
	Links       []ArtifactHubChangelogObjectLinks `yaml:"links,omitempty"`
}

func GenerateChangelogForRepo

func GenerateChangelogForRepo(from, to, repoURL string, subdirectories []string) []*ArtifactHubChangelogObject

type ArtifactHubChangelogObjectLinks

type ArtifactHubChangelogObjectLinks struct {
	Name string `yaml:"name"`
	Url  string `yaml:"url"`
}

type ArtifactHubChangelogResolverInterface

type ArtifactHubChangelogResolverInterface interface {
	ResolveChangelogEntry() (*ArtifactHubChangelogObject, error)
	// contains filtered or unexported methods
}

func NewCommitResolver

func NewCommitResolver(c *object.Commit, r Resolver) ArtifactHubChangelogResolverInterface

type ConventionalCommitsResolver

type ConventionalCommitsResolver struct {
	*object.Commit
}

see e.g.: @commitlint/config-conventional https://www.conventionalcommits.org/en/v1.0.0/#specification

func NewConventionalCommitsResolver

func NewConventionalCommitsResolver(c *object.Commit) *ConventionalCommitsResolver

func (*ConventionalCommitsResolver) ResolveChangelogEntry

func (r *ConventionalCommitsResolver) ResolveChangelogEntry() (*ArtifactHubChangelogObject, error)

type Resolver

type Resolver string

const (
	ConventionalCommits Resolver = "conventional-commits"
)