Allow setting source_repo_url via parameter (#90)

* Part of work to make it easier for people to manage catalog types in github * Allow new SOURCE_REPO_URL parameter to be passed, this will be set via a github action workflow that we generate for users * If this is set, it will create/update the source repo url when creating/updating the catalog type
incident-io · Mar 12, 2024 · c6957cd · c6957cd
1 parent 9811c58
commit c6957cd
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 17 deletions.
diff --git a/client/client.gen.go b/client/client.gen.go
diff --git a/client/openapi3.json b/client/openapi3.json
@@ -5660,6 +5660,11 @@
             "description": "When this type was last updated",
             "example": "2021-08-17T13:28:57.801578Z",
             "format": "date-time"
+          },
+          "source_repo_url": {
+            "type": "string",
+            "description": "The url of the external repository where this type is managed",
+            "example": "https://github.com/incident-io/catalog-importer"
           }
         },
         "example": {
@@ -5692,7 +5697,8 @@
           },
           "semantic_type": "custom",
           "type_name": "Custom[\"BackstageGroup\"]",
-          "updated_at": "2021-08-17T13:28:57.801578Z"
+          "updated_at": "2021-08-17T13:28:57.801578Z",
+          "source_repo_url": "https://github.com/incident-io/catalog-importer"
         },
         "required": [
           "id",
@@ -6567,6 +6573,11 @@
             "type": "string",
             "description": "The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom[\"SomeName \"]",
             "example": "Custom[\"BackstageGroup\"]"
+          },
+          "source_repo_url": {
+            "type": "string",
+            "description": "The url of the external repository where this type is managed",
+            "example": "https://github.com/incident-io/catalog-importer"
           }
         },
         "example": {
@@ -6579,7 +6590,8 @@
           "name": "Kubernetes Cluster",
           "ranked": true,
           "semantic_type": "custom",
-          "type_name": "Custom[\"BackstageGroup\"]"
+          "type_name": "Custom[\"BackstageGroup\"]",
+          "source_repo_url": "https://github.com/incident-io/catalog-importer"
         },
         "required": [
           "name",
@@ -11550,6 +11562,11 @@
             "type": "string",
             "description": "Semantic type of this resource",
             "example": "custom"
+          },
+          "source_repo_url": {
+            "type": "string",
+            "description": "The url of the external repository where this type is managed",
+            "example": "https://github.com/incident-io/catalog-importer"
           }
         },
         "example": {
@@ -11561,7 +11578,8 @@
           "icon": "bolt",
           "name": "Kubernetes Cluster",
           "ranked": true,
-          "semantic_type": "custom"
+          "semantic_type": "custom",
+          "source_repo_url": "https://github.com/incident-io/catalog-importer"
         },
         "required": [
           "name",

diff --git a/cmd/catalog-importer/cmd/sync.go b/cmd/catalog-importer/cmd/sync.go
@@ -31,6 +31,7 @@ type SyncOptions struct {
 	DryRun         bool
 	Prune          bool
 	AllowDeleteAll bool
+	SourceRepoUrl  string
 }
 
 func (opt *SyncOptions) Bind(cmd *kingpin.CmdClause) *SyncOptions {
@@ -43,6 +44,9 @@ func (opt *SyncOptions) Bind(cmd *kingpin.CmdClause) *SyncOptions {
 	cmd.Flag("api-key", "API key for incident.io").
 		Envar("INCIDENT_API_KEY").
 		StringVar(&opt.APIKey)
+	cmd.Flag("source-repo-url", "URL of repo where catalog is being managed").
+		Envar("SOURCE_REPO_URL").
+		StringVar(&opt.SourceRepoUrl)
 	cmd.Flag("target", `Restrict running to only these outputs (e.g. Custom["Customer"])`).
 		StringsVar(&opt.Targets)
 	cmd.Flag("sample-length", "How many character to sample when logging about invalid source entries (for --debug only)").
@@ -187,19 +191,21 @@ func (opt *SyncOptions) Run(ctx context.Context, logger kitlog.Logger, cfg *conf
 			if opt.DryRun {
 				logger.Log("msg", "catalog type does not already exist, simulating create for --dry-run")
 				createdCatalogType = client.CatalogTypeV2{
-					Id:          fmt.Sprintf("DRY-RUN-%s", model.TypeName),
-					Name:        model.Name,
-					Description: model.Description,
-					TypeName:    model.TypeName,
+					Id:            fmt.Sprintf("DRY-RUN-%s", model.TypeName),
+					Name:          model.Name,
+					Description:   model.Description,
+					TypeName:      model.TypeName,
+					SourceRepoUrl: &opt.SourceRepoUrl,
 				}
 			} else {
 				logger.Log("msg", "catalog type does not already exist, creating")
 				result, err := cl.CatalogV2CreateTypeWithResponse(ctx, client.CreateTypeRequestBody{
-					Name:        model.Name,
-					Description: model.Description,
-					Ranked:      &model.Ranked,
-					TypeName:    lo.ToPtr(model.TypeName),
-					Annotations: lo.ToPtr(getAnnotations(cfg.SyncID)),
+					Name:          model.Name,
+					Description:   model.Description,
+					Ranked:        &model.Ranked,
+					TypeName:      lo.ToPtr(model.TypeName),
+					Annotations:   lo.ToPtr(getAnnotations(cfg.SyncID)),
+					SourceRepoUrl: &opt.SourceRepoUrl,
 				})
 				if err != nil {
 					return errors.Wrap(err, fmt.Sprintf("creating catalog type with name %s", model.TypeName))
@@ -263,10 +269,11 @@ func (opt *SyncOptions) Run(ctx context.Context, logger kitlog.Logger, cfg *conf
 			} else {
 				logger.Log("msg", "updating catalog type", "catalog_type_id", catalogType.Id)
 				result, err := cl.CatalogV2UpdateTypeWithResponse(ctx, catalogType.Id, client.CatalogV2UpdateTypeJSONRequestBody{
-					Name:        model.Name,
-					Description: model.Description,
-					Ranked:      &model.Ranked,
-					Annotations: lo.ToPtr(getAnnotations(cfg.SyncID)),
+					Name:          model.Name,
+					Description:   model.Description,
+					Ranked:        &model.Ranked,
+					Annotations:   lo.ToPtr(getAnnotations(cfg.SyncID)),
+					SourceRepoUrl: &opt.SourceRepoUrl,
 				})
 				if err != nil {
 					return errors.Wrap(err, fmt.Sprintf("updating catalog type with name %s", model.TypeName))

diff --git a/output/marshal.go b/output/marshal.go
@@ -19,6 +19,7 @@ type CatalogTypeModel struct {
 	Ranked          bool
 	Attributes      []client.CatalogTypeAttributePayloadV2
 	SourceAttribute *Attribute // tracks the origin attribute, if an enum model
+	SourceRepoUrl string
 }
 
 type CatalogEntryModel struct {