changelogutils

Documentation

Index

• func AccumulateNotes(enterpriseReleaseNotes string, openSourceReleaseMap map[Version]string, ...) string
• func GetAllOSSDependenciesBetweenEnterpriseVersions(startVersion, endVersion *Version, versionsSorted []*github.RepositoryRelease) []Version
• func GetAllReleases(client *github.Client, repo string) ([]*github.RepositoryRelease, error)
• func GetOSDependencyPrefix(openSourceVersion Version, isHeader bool) string
• func GetOSSDependencyForEnterpriseVersion(enterpriseVersion *Version) (*Version, error)
• func GetPreviousEnterprisePatchVersion(enterpriseReleasesSorted []*github.RepositoryRelease, index int) *Version
• func GetReleaseMdLink(releaseTag, repo string) string
• func MergeEnterpriseOSSReleases(enterpriseReleases, osReleasesSorted []*github.RepositoryRelease, ...) (map[Version]string, []Version, error)
• func ParseReleaseNotes(releaseNotes string, headersToNotesMap map[string][]string, prefix string) string
• func ParseReleases(releases []*github.RepositoryRelease, byMinorVersion bool) (map[Version]string, error)
• func SortReleaseVersions(versions []Version) []Version
• func SortReleases(releases []*github.RepositoryRelease) []*github.RepositoryRelease

Functions

func AccumulateNotes

func AccumulateNotes(enterpriseReleaseNotes string, openSourceReleaseMap map[Version]string, depVersions []Version) string

Parses the enterprise release notes, then inserts open source release notes for each of the dependent versions of gloo Open source between the current release and the previous release

func GetAllOSSDependenciesBetweenEnterpriseVersions

func GetAllOSSDependenciesBetweenEnterpriseVersions(startVersion, endVersion *Version, versionsSorted []*github.RepositoryRelease) []Version

Get the list of open source versions between open source version that the previous enterprise version used and the current enterprise version uses

func GetAllReleases

func GetAllReleases(client *github.Client, repo string) ([]*github.RepositoryRelease, error)

Fetches releases for repo from github

func GetOSDependencyPrefix

func GetOSDependencyPrefix(openSourceVersion Version, isHeader bool) string

func GetOSSDependencyForEnterpriseVersion

func GetOSSDependencyForEnterpriseVersion(enterpriseVersion *Version) (*Version, error)

func GetPreviousEnterprisePatchVersion

func GetPreviousEnterprisePatchVersion(enterpriseReleasesSorted []*github.RepositoryRelease, index int) *Version

func GetReleaseMdLink

func GetReleaseMdLink(releaseTag, repo string) string

func MergeEnterpriseOSSReleases

func MergeEnterpriseOSSReleases(enterpriseReleases, osReleasesSorted []*github.RepositoryRelease, sortedByVersion bool) (map[Version]string, []Version, error)

Performs processing to generate a map of release version to the release notes This also pulls in open source gloo edge release notes and merges them with enterprise release notes The returned map will be a mapping of minor releases (v1.5, v1.6) to their body, which will contain the release notes for all the patches under the minor releases. It also returns a list of versions, sorted by version if the sortedByVersion param is true.

func ParseReleaseNotes

func ParseReleaseNotes(releaseNotes string, headersToNotesMap map[string][]string, prefix string) string

Parses the release notes for a release version into a map `headersToNotesMap` which maps each of the headers (e.g. Fixes, Dependency Bumps, New Features) to the release notes under the header

func ParseReleases

func ParseReleases(releases []*github.RepositoryRelease, byMinorVersion bool) (map[Version]string, error)

Parses releases into correct format for printing If byMinorVersion is true, the version header (e.g. v1.5.9-beta8) is not included in the release notes body

func SortReleaseVersions

func SortReleaseVersions(versions []Version) []Version

Sorts a slice of versions in descending order by version e.g. v1.6.1, v1.6.0, v1.6.0-beta9

func SortReleases

func SortReleases(releases []*github.RepositoryRelease) []*github.RepositoryRelease