feat: expose fields via yaml "Full" config

Author: jimschubert

README.md

@@ -13,12 +13,14 @@ Usage:
 Flags:
       --config-path string   A custom config path, relative to the repository root
       --data string          A JSON string of the 'event' type (issue event or pull request event)
+      --fields strings       Fields to evaluate for labeling (title, body) (default [title,body])
   -h, --help                 help for labeler
       --id int               The integer id of the issue or pull request
   -o, --owner string         GitHub Owner/Org name [GITHUB_ACTOR]
   -r, --repo string          GitHub Repo name [GITHUB_REPO]
   -t, --type string          The target event type to label (issues or pull_request) [GITHUB_EVENT_NAME]
   -v, --version              version for labeler
+
 ```
 
 Example usage:
@@ -70,6 +72,8 @@ labels:
     - '\bquestion\b'
 ```
 
+Note that simple schema doesn't allow for some of the more advanced features of the full schema, such as excluding patterns or customizing comments for issues and pull requests. If you need those features, consider using the full schema.
+
 ### Full Schema
 
 ```yaml
@@ -81,6 +85,11 @@ enable:
   prs: true
 # comments object allows you to specify a different message for issues and prs
 
+# (Optional): Determine which fields of the issue or pull request to evaluate.
+fields:
+  - title
+  - body
+
 comments:
   issues: |
     Thanks for opening this issue!

labeler.go

@@ -205,6 +205,10 @@ func (l *Labeler) applyLabels(i githubEvent, existingLabels []*github.Label) int
 	flags := l.fieldFlag.OrDefault()
 	fields := make([]string, 0)
 
+	if overrideFields, ok := l.config.(*model.FullConfig); ok && len(overrideFields.Fields) > 0 {
+		flags = ParseFieldFlags(overrideFields.Fields)
+	}
+
 	if flags.Has(FieldTitle) {
 		fields = append(fields, i.GetTitle())
 	}

labeler_test.go

@@ -275,7 +275,6 @@ func TestLabeler_Execute_success_issue(t *testing.T) {
 	ctx := context.Background()
 	mockClient := new(mockRichClient)
 
-	mockCfg := new(mockConfig)
 	l := &Labeler{
 		Owner:      ptr("owner"),
 		Repo:       ptr("repo"),
@@ -296,14 +295,106 @@ labels:
     - '\bdupe\b'
   'question':
     - '\bquestion\b'
+`))), nil, nil)
+	mockClient.On("GetIssue", mock.Anything, "owner", "repo", 1).Return(&github.Issue{Title: ptr("title"), Body: ptr("body")}, nil, nil)
+	err := l.Execute()
+	assert.NoError(t, err)
+
+	mockClient.AssertNumberOfCalls(t, "GetIssue", 1)
+	mockClient.AssertExpectations(t)
+}
+
+func TestLabeler_Execute_allows_config_override_fields_title(t *testing.T) {
+	ctx := context.Background()
+	mockClient := new(mockRichClient)
+
+	l := &Labeler{
+		Owner:      ptr("owner"),
+		Repo:       ptr("repo"),
+		Event:      ptr("issues"),
+		ID:         ptr(1),
+		context:    &ctx,
+		client:     mockClient,
+		configPath: ".github/labeler.yml",
+		fieldFlag:  AllFieldFlags,
+	}
+	mockClient.On("DownloadContents", mock.Anything, "owner", "repo", ".github/labeler.yml", mock.Anything).
+		Return(io.NopCloser(bytes.NewReader([]byte(
+			`%YAML 1.1
+---
+enable:
+  issues: true
+  prs: false
+
+fields:
+  - title
+
+labels:
+  'bug':
+    include:
+      - '\btitle[s]?\b'
+    exclude: []
+  'help wanted':
+    include:
+      - '\bbody( me)?\b'
+`))), nil, nil)
+	mockClient.On("GetIssue", mock.Anything, "owner", "repo", 1).Return(&github.Issue{Title: ptr("title"), Body: ptr("body")}, nil, nil)
+	mockClient.On("AddLabelsToIssue", mock.Anything, "owner", "repo", 1, []string{"bug"}).Return([]*github.Label{{Name: ptr("bug")}}, nil, nil)
+	err := l.Execute()
+	assert.NoError(t, err)
+
+	mockClient.AssertNumberOfCalls(t, "GetIssue", 1)
+	mockClient.AssertCalled(t, "AddLabelsToIssue", mock.Anything, "owner", "repo", 1, []string{"bug"})
+	mockClient.AssertNumberOfCalls(t, "AddLabelsToIssue", 1)
+	mockClient.AssertExpectations(t)
+}
+
+func TestLabeler_Execute_allows_config_override_fields_body(t *testing.T) {
+	ctx := context.Background()
+	mockClient := new(mockRichClient)
+
+	mockCfg := new(mockConfig)
+	l := &Labeler{
+		Owner:      ptr("owner"),
+		Repo:       ptr("repo"),
+		Event:      ptr("issues"),
+		ID:         ptr(1),
+		context:    &ctx,
+		client:     mockClient,
+		configPath: ".github/labeler.yml",
+		fieldFlag:  AllFieldFlags,
+	}
+	mockClient.On("DownloadContents", mock.Anything, "owner", "repo", ".github/labeler.yml", mock.Anything).
+		Return(io.NopCloser(bytes.NewReader([]byte(
+			`%YAML 1.1
+---
+enable:
+  issues: true
+  prs: false
+
+fields:
+  - body
+
+labels:
+  'bug':
+    include:
+      - '\btitle[s]?\b'
+    exclude: []
+  'help wanted':
+    include:
+      - '\bbody\b'
+
 `))), nil, nil)
 	mockCfg.On("FromBytes", mock.Anything).Return(nil)
-	mockCfg.On("LabelsFor", mock.Anything, mock.Anything).Return(map[string]model.Label{})
-	mockClient.On("GetIssue", mock.Anything, "owner", "repo", 1).Return(&github.Issue{Title: ptr("t"), Body: ptr("b")}, nil, nil)
+	mockCfg.On("LabelsFor", "body").Return(map[string]model.Label{})
+	mockClient.On("GetIssue", mock.Anything, "owner", "repo", 1).Return(&github.Issue{Title: ptr("title"), Body: ptr("body")}, nil, nil)
+	mockClient.On("AddLabelsToIssue", mock.Anything, "owner", "repo", 1, []string{"help wanted"}).Return([]*github.Label{{Name: ptr("help wanted")}}, nil, nil)
 	err := l.Execute()
 	assert.NoError(t, err)
 
 	mockClient.AssertNumberOfCalls(t, "GetIssue", 1)
+	mockClient.AssertCalled(t, "AddLabelsToIssue", mock.Anything, "owner", "repo", 1, []string{"help wanted"})
+	mockClient.AssertNumberOfCalls(t, "AddLabelsToIssue", 1)
 	mockClient.AssertExpectations(t)
 }
 

model/config.go

@@ -8,3 +8,8 @@ type Config interface {
 	// LabelsFor allows config implementations to determine the labels to be applied to the input strings
 	LabelsFor(text ...string) map[string]Label
 }
+
+type FieldOverrides interface {
+	// IncludedFields returns the fields that are used for labeling, if not defined, it returns an empty slice
+	IncludedFields() []string
+}

model/full_config.go

@@ -33,6 +33,7 @@ type (
 		Enable   *Enable          `yaml:"enable,omitempty"`
 		Comments *Comments        `yaml:"comments,omitempty"`
 		Labels   map[string]Label `yaml:"labels,flow"`
+		Fields   []string         `yaml:"fields,omitempty,flow"`
 	}
 )
 
@@ -50,6 +51,18 @@ func (f *FullConfig) FromBytes(b []byte) error {
 	return nil
 }
 
+// IncludedFields returns the fields that are used for labeling, if not defined, it returns an empty slice
+func (f *FullConfig) IncludedFields() []string {
+	fields := make([]string, 0)
+	if f.Fields == nil || len(f.Fields) == 0 {
+		return fields
+	}
+	for _, field := range f.Fields {
+		fields = append(fields, strings.ToLower(field))
+	}
+	return fields
+}
+
 // LabelsFor allows config implementations to determine the labels to be applied to the input strings
 func (f *FullConfig) LabelsFor(text ...string) map[string]Label {
 	searchable := []byte(strings.Join(text, " "))

model/full_config_test.go

@@ -14,6 +14,7 @@ func TestFullConfig_FromBytes(t *testing.T) {
 		Enable   *Enable
 		Comments *Comments
 		Labels   map[string]Label
+		Fields   []string
 	}
 	type args struct {
 		b []byte
@@ -48,7 +49,36 @@ func TestFullConfig_FromBytes(t *testing.T) {
 				}.Ptr(),
 			},
 			args{helperTestData(t, "full_config.yaml")},
-			false},
+			false,
+		},
+
+		{"full config title only",
+			fields{
+				Labels: map[string]Label{
+					"bug": {
+						Include:  []string{"\\bbug[s]?\\b"},
+						Exclude:  []string{},
+						Branches: []string{"main", "develop"},
+					},
+					"enhancement": {
+						Include: []string{"\\bfeat\\b"},
+						Exclude: []string{},
+					},
+					"help wanted": {
+						Include: []string{"\\bhelp( me)?\\b"},
+						Exclude: []string{"\\b\\[test(ing)?\\]\\b"},
+					},
+				},
+				Enable: Enable{Issues: &btrue, PullRequests: &bfalse}.Ptr(),
+				Comments: Comments{
+					Issues:       p("👍 Thanks for this!"),
+					PullRequests: p("I applied labels to your pull request.\n\nPlease review the labels.\n"),
+				}.Ptr(),
+				Fields: []string{"title"},
+			},
+			args{helperTestData(t, "full_config_title_only.yaml")},
+			false,
+		},
 		{"full config labels only",
 			fields{
 				Labels: map[string]Label{
@@ -88,6 +118,7 @@ func TestFullConfig_FromBytes(t *testing.T) {
 				assert.Equal(t, tt.fields.Enable, f.Enable)
 				assert.Equal(t, tt.fields.Comments, f.Comments)
 				assert.Equal(t, tt.fields.Labels, f.Labels)
+				assert.Equal(t, tt.fields.Fields, f.Fields)
 			}
 		})
 	}

model/testdata/full_config_title_only.yaml

@@ -0,0 +1,33 @@
+%YAML 1.1
+---
+enable:
+  issues: true
+  prs: false
+
+fields:
+  - title
+
+comments:
+  issues: 👍 Thanks for this!
+  prs: |
+    I applied labels to your pull request.
+
+    Please review the labels.
+
+labels:
+  'bug':
+    include:
+      - '\bbug[s]?\b'
+    exclude: []
+    branches:
+      - main
+      - develop
+  'help wanted':
+    include:
+      - '\bhelp( me)?\b'
+    exclude:
+      - '\b\[test(ing)?\]\b'
+  'enhancement':
+    include:
+      - '\bfeat\b'
+    exclude: []