source

package

v0.8.1 Latest Latest Go to latest Published: Jun 10, 2026 License: AGPL-3.0 Imports: 23 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type ForgejoFile struct {
	URL string
}

type ID string

A unique identifier for a source

func NewForgejoID(project, path string) ID

func NewGitHubID(owner, repo, path string) ID

func NewGitLabID(project, path string) ID

func NewIDFromChangelog(cl store.Changelog) ID

func NewLocalID(path string) ID

func (i ID) String() string

type LoadResult struct {
	Raw     []RawReleaseNote
	HasMore bool
}

func (r LoadResult) HasChanged() bool

Returns if any of the loaded release notes have changed since last access.

type RawReleaseNote struct {
	Content io.Reader
	// contains filtered or unexported fields
}

type Source interface {
	Load(ctx context.Context, page internal.Pagination) (LoadResult, error)
	ID() ID
}

A source can be used to load raw release notes from a (remote) source like GitHub.

func NewFJSourceFromStore(cfg config.Config, fj store.FJSource, cache xcache.Cache) (Source, error)

func NewGHSourceFromStore(cfg config.Config, gh store.GHSource, cache xcache.Cache) (Source, error)

func NewGLSourceFromStore(cfg config.Config, gl store.GLSource, cache xcache.Cache) (Source, error)

func NewLocalSourceFromStore(s store.LocalSource, cache xcache.Cache) Source

func NewSourceFromStore(cfg config.Config, cl store.Changelog, cache xcache.Cache) (Source, error)