Add owner.type field to create package and docs

taylor-swanson · taylor-swanson · commit 5054b6601e51 · 2023-09-19T08:49:17.000-05:00
- Add prompt for owner.type field
- Add section to breaking changes docs for now required owner.type field
diff --git a/cmd/create_package.go b/cmd/create_package.go
@@ -36,6 +36,7 @@ type newPackageAnswers struct {
 	KibanaVersion       string `survey:"kibana_version"`
 	ElasticSubscription string `survey:"elastic_subscription"`
 	GithubOwner         string `survey:"github_owner"`
+	OwnerType           string `survey:"owner_type"`
 	DataStreamType      string `survey:"datastream_type"`
 }
 
@@ -149,6 +150,27 @@ func createPackageCommandAction(cmd *cobra.Command, args []string) error {
 			},
 			Validate: survey.ComposeValidators(survey.Required, surveyext.GithubOwnerValidator),
 		},
+		{
+			Name: "owner_type",
+			Prompt: &survey.Select{
+				Message: "Owner type:",
+				Options: []string{"elastic", "partner", "community"},
+				Description: func(value string, _ int) string {
+					switch value {
+					case "elastic":
+						return "Owned and supported by Elastic"
+					case "partner":
+						return "Vendor-owned with support from Elastic"
+					case "community":
+						return "Supported by the community"
+					}
+
+					return ""
+				},
+				Default: "elastic",
+			},
+			Validate: survey.Required,
+		},
 	}
 
 	if answers.Type == "input" {
@@ -217,6 +239,7 @@ func createPackageDescriptorFromAnswers(answers newPackageAnswers) archetype.Pac
 			},
 			Owner: packages.Owner{
 				Github: answers.GithubOwner,
+				Type:   answers.OwnerType,
 			},
 			License:     answers.ElasticSubscription,
 			Description: answers.Description,
diff --git a/cmd/status_test.go b/cmd/status_test.go
@@ -28,6 +28,7 @@ func fooPackage(version, kibanaVersion string) packages.PackageManifest {
 		Description: "Foo integration",
 		Owner: packages.Owner{
 			Github: "team",
+			Type:   "elastic",
 		},
 		Conditions: packages.Conditions{
 			Kibana: packages.KibanaConditions{Version: kibanaVersion},
diff --git a/docs/howto/update_major_package_spec.md b/docs/howto/update_major_package_spec.md
@@ -76,6 +76,29 @@ routing rules.
 If you find this error while trying to use a new processor, please open an issue
 in the Package Spec repository so we can add support for it.
 
+### field owner: type is required
+
+Package Spec 3.0.0 now requires the owner type field to be set. This field
+describes who owns the package and the level of support that is provided.
+The 'elastic' value indicates that the package is built and maintained by
+Elastic. The 'partner' value indicates that the package is built and
+maintained by a partner vendor and may include involvement from Elastic.
+The 'community' value indicates the package is built and maintained by
+non-Elastic community members.
+
+The field was initially introduced in Package Spec `2.11.0` and 
+
+The value must be one of the following:
+
+- `elastic`
+- `partner`
+- `community`
+
+```
+owner:
+  type: elastic
+```
+
 ## Troubleshooting upgrades to Package Spec v2
 
 ### field (root): Additional property license is not allowed
diff --git a/internal/packages/archetype/_static/package-manifest.yml.tmpl b/internal/packages/archetype/_static/package-manifest.yml.tmpl
@@ -74,3 +74,4 @@ policy_templates:
 {{ end -}}
 owner:
   github: {{.Manifest.Owner.Github}}
+  type: {{.Manifest.Owner.Type}}
diff --git a/internal/packages/archetype/package_test.go b/internal/packages/archetype/package_test.go
@@ -73,6 +73,7 @@ func createPackageDescriptorForTest(packageType, kibanaVersion string) PackageDe
 			},
 			Owner: packages.Owner{
 				Github: "mtojek",
+				Type:   "elastic",
 			},
 			Description: "This package has been generated by a Go unit test.",
 			Categories:  []string{"aws", "custom"},
diff --git a/internal/packages/packages.go b/internal/packages/packages.go
@@ -112,6 +112,7 @@ type PolicyTemplate struct {
 // Owner defines package owners, either a single person or a team.
 type Owner struct {
 	Github string `config:"github" json:"github" yaml:"github"`
+	Type   string `config:"type" json:"type" yaml:"type"`
 }
 
 // PackageManifest represents the basic structure of a package's manifest

Original file line number	Diff line number	Diff line change
`@@ -112,6 +112,7 @@ type PolicyTemplate struct {`
`112`	`112`	`// Owner defines package owners, either a single person or a team.`
`113`	`113`	`type Owner struct {`
`114`	`114`	Github string `config:"github" json:"github" yaml:"github"`
	`115`	+ Type string `config:"type" json:"type" yaml:"type"`
`115`	`116`	`}`
`116`	`117`
`117`	`118`	`// PackageManifest represents the basic structure of a package's manifest`