fix: added documentation for new config field

jenkins-x · Sep 1, 2022 · 100285c · 100285c
1 parent 58ba156
commit 100285c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/cmd/keeper/config.md b/cmd/keeper/config.md
@@ -14,6 +14,7 @@ The following configuration fields are available:
 * `status_update_period`: The field specifies how often Tide will update GitHub status contexts.
    Defaults to the value of `sync_period`.
 * `queries`: List of queries (described below).
+* `default_merge_method`: The default merge type for lighthouse to use, and the merge_method list will override this. Defaults to "merge"
 * `merge_method`: A key/value pair of an `org/repo` as the key and merge method to override
    the default method of merge as value. Valid options are `squash`, `rebase`, and `merge`.
    Defaults to `merge`.

diff --git a/pkg/config/keeper/config.go b/pkg/config/keeper/config.go
@@ -35,7 +35,7 @@ type Config struct {
 	// Queries represents a list of GitHub search queries that collectively
 	// specify the set of PRs that meet merge requirements.
 	Queries Queries `json:"queries,omitempty"`
-	// The default merge type for lighthouse to use, and in the normal merge type list will override this. Defaults to "merge"
+	// The default merge type for lighthouse to use, and the merge_method list will override this. Defaults to "merge"
 	DefaultMergeType PullRequestMergeType `json:"default_merge_method,omitempty"`
 	// A key/value pair of an org/repo as the key and merge method to override
 	// the default method of merge. Valid options are squash, rebase, and merge.