Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GitHubReleases ¶
type GitHubReleases struct { Owner string // REQUIRED. Owner of the repo. Repo string // REQUIRED. Name of the repo. Release string // REQUIRED. Tag name of the release you want to check. Client *github.Client // Github client used to make the calls to the github api. Versions []*version.Version // Ordered list of all versions. ReleaseNotes map[string]string // A map of releases with release notes. Options *Options // Optional options }
GitHubReleases holds the two releases to compare
func New ¶
func New(client *github.Client, owner string, repo string, release string, options *Options) (*GitHubReleases, *github.Response, error)
New creates a new GitHubReleases
func (*GitHubReleases) Diff ¶
func (ghr *GitHubReleases) Diff() int
func (*GitHubReleases) DiffWithReleaseNotes ¶ added in v0.3.0
func (ghr *GitHubReleases) DiffWithReleaseNotes() (int, []ReleaseNote)
Diff will fetch all releases until a specific release
type Options ¶ added in v0.1.3
type Options struct { Release string // Tag name of the release you want to compare with. If empty, newest version will be used. Filter string // Regex to to filter releases on. Keep empty if you want all releases. IncludePreReleases bool // Whether to include pre-releases or not. Default is false. IncludeDrafts bool // Whether to include drafts or not. Default is false. VerifyRelease bool // Whether to verify that the provided versions exists as a release. }
Options is optional stuff that can be sent when calling "New"
type ReleaseNote ¶ added in v0.3.0
Click to show internal directories.
Click to hide internal directories.