feat: add includeLabels option to release-notes

Author: jackfrancis

cmd/krel/cmd/release_notes.go

@@ -138,6 +138,7 @@ type releaseNotesOptions struct {
 	githubOrg          string
 	draftRepo          string
 	mapProviders       []string
+	includeLabels      []string
 }
 
 type releaseNotesResult struct {
@@ -241,6 +242,14 @@ func init() {
 		"update the cloned repository to fetch any upstream change (default: true)",
 	)
 
+	releaseNotesCmd.PersistentFlags().StringSliceVarP(
+		&releaseNotesOpts.includeLabels,
+		"include-labels",
+		"l",
+		[]string{},
+		"specify one or more PR labels to include in release notes",
+	)
+
 	rootCmd.AddCommand(releaseNotesCmd)
 }
 
@@ -909,6 +918,7 @@ func releaseNotesJSON(repoPath, tag string) (jsonString string, err error) {
 	notesOptions.Debug = logrus.StandardLogger().Level >= logrus.DebugLevel
 	notesOptions.MapProviderStrings = releaseNotesOpts.mapProviders
 	notesOptions.AddMarkdownLinks = true
+	notesOptions.IncludeLabels = releaseNotesOpts.includeLabels
 
 	// If the release for the tag we are using has a mapping directory,
 	// add it to the mapProviders array to read the edits from the release team:
@@ -964,6 +974,7 @@ func gatherNotesFrom(repoPath, startTag string) (*notes.ReleaseNotes, error) {
 	notesOptions.MapProviderStrings = releaseNotesOpts.mapProviders
 	notesOptions.ListReleaseNotesV2 = releaseNotesOpts.listReleaseNotesV2
 	notesOptions.AddMarkdownLinks = true
+	notesOptions.IncludeLabels = releaseNotesOpts.includeLabels
 
 	if err := notesOptions.ValidateAndFinish(); err != nil {
 		return nil, err

cmd/release-notes/generate.go

@@ -249,6 +249,14 @@ func addGenerateFlags(subcommand *cobra.Command) {
 		false,
 		"enable experimental implementation to list commits (ListReleaseNotesV2)",
 	)
+
+	subcommand.PersistentFlags().StringSliceVarP(
+		&opts.IncludeLabels,
+		"include-labels",
+		"l",
+		[]string{},
+		"specify one or more PR labels to include in release notes",
+	)
 }
 
 // addGenerate adds the generate subcomand to the main release notes cobra cmd.

pkg/changelog/changelog.go

@@ -37,19 +37,20 @@ import (
 
 // Options are the main settings for generating the changelog.
 type Options struct {
-	RepoPath     string
-	Tag          string
-	Branch       string
-	Bucket       string
-	Tars         string
-	Images       string
-	HTMLFile     string
-	JSONFile     string
-	RecordDir    string
-	ReplayDir    string
-	CVEDataDir   string
-	CloneCVEMaps bool
-	Dependencies bool
+	RepoPath      string
+	Tag           string
+	Branch        string
+	Bucket        string
+	Tars          string
+	Images        string
+	HTMLFile      string
+	JSONFile      string
+	RecordDir     string
+	ReplayDir     string
+	CVEDataDir    string
+	CloneCVEMaps  bool
+	Dependencies  bool
+	IncludeLabels []string
 }
 
 // Changelog can be used to generate the changelog for a release.
@@ -278,6 +279,7 @@ func (c *Changelog) generateReleaseNotes(
 	notesOptions.ReplayDir = c.options.ReplayDir
 	notesOptions.Pull = false
 	notesOptions.AddMarkdownLinks = true
+	notesOptions.IncludeLabels = c.options.IncludeLabels
 
 	if c.options.CVEDataDir != "" {
 		notesOptions.MapProviderStrings = append(

pkg/notes/notes.go

@@ -681,6 +681,18 @@ func MatchesExcludeFilter(msg string) bool {
 	return matchesFilter(msg, noteExclusionFilters)
 }
 
+// matchesLabelFilter returns true if any of PR labels match the includeLabels
+func matchesLabelFilter(prLabels []*gogithub.Label, includeLabels []string) bool {
+	for _, include := range includeLabels {
+		for _, label := range prLabels {
+			if label.GetName() == include {
+				return true
+			}
+		}
+	}
+	return false
+}
+
 func matchesFilter(msg string, filters []*regexp.Regexp) bool {
 	for _, filter := range filters {
 		if filter.MatchString(msg) {

pkg/notes/notes_v2.go

@@ -157,6 +157,10 @@ func (g *Gatherer) buildReleaseNote(pair *commitPrPair) (*ReleaseNote, error) {
 		return nil, nil
 	}
 
+	if len(g.options.IncludeLabels) > 0 && !matchesLabelFilter(pr.Labels, g.options.IncludeLabels) {
+		return nil, nil
+	}
+
 	text, err := noteTextFromString(prBody)
 	if err != nil {
 		logrus.WithFields(logrus.Fields{

pkg/notes/options/options.go

@@ -133,6 +133,9 @@ type Options struct {
 	// This is useful when the release notes are outputted to a file. When using the GitHub release page to publish release notes,
 	// this option should be set to false to take advantage of Github's autolinked references.
 	AddMarkdownLinks bool
+
+	// IncludeLabels enables including only PRs that have one or more specific labels.
+	IncludeLabels []string
 }
 
 type RevisionDiscoveryMode string
@@ -167,6 +170,7 @@ func New() *Options {
 		gitCloneFn:         git.CloneOrOpenGitHubRepo,
 		MapProviderStrings: []string{},
 		AddMarkdownLinks:   false,
+		IncludeLabels:      []string{},
 	}
 }