From 5c8e99ce191b6e5fb9b14771fe5eb64cdbc6ad62 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Sun, 22 Nov 2020 20:38:57 -0500 Subject: [PATCH 1/4] Fix entity YAML name --- docs/features/software-catalog/descriptor-format.md | 2 +- plugins/circleci/README.md | 2 +- plugins/jenkins/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 5d7a5b9af0..c3adaabc45 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -43,7 +43,7 @@ software catalog API. "kind": "Component", "metadata": { "annotations": { - "backstage.io/managed-by-location": "file:/tmp/component-info.yaml", + "backstage.io/managed-by-location": "file:/tmp/catalog-info.yaml", "example.com/service-discovery": "artistweb", "circleci.com/project-slug": "github/example-org/artist-website" }, diff --git a/plugins/circleci/README.md b/plugins/circleci/README.md index 00a39ce6c8..c96de56617 100644 --- a/plugins/circleci/README.md +++ b/plugins/circleci/README.md @@ -61,7 +61,7 @@ proxy: ``` 5. Get and provide `CIRCLECI_AUTH_TOKEN` as env variable (https://circleci.com/docs/api/#add-an-api-token) -6. Add `circleci.com/project-slug` annotation to your component-info.yaml file in format // (https://backstage.io/docs/architecture-decisions/adrs-adr002#format) +6. Add `circleci.com/project-slug` annotation to your catalog-info.yaml file in format // (https://backstage.io/docs/architecture-decisions/adrs-adr002#format) ```yaml apiVersion: backstage.io/v1alpha1 diff --git a/plugins/jenkins/README.md b/plugins/jenkins/README.md index 1d3e7f60e5..5e0a701caf 100644 --- a/plugins/jenkins/README.md +++ b/plugins/jenkins/README.md @@ -41,7 +41,7 @@ export JENKINS_BASIC_AUTH_HEADER="Basic $HEADER" ``` 5. Run app with `yarn start` -6. Add the Jenkins folder annotation to your `component-info.yaml`, (note: currently this plugin only supports folders and Git SCM) +6. Add the Jenkins folder annotation to your `catalog-info.yaml`, (note: currently this plugin only supports folders and Git SCM) ```yaml apiVersion: backstage.io/v1alpha1 From da8ca6cd1c13e13390b36da8f9ae84b7d0396317 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Sun, 22 Nov 2020 20:51:05 -0500 Subject: [PATCH 2/4] Fix typo --- plugins/circleci/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/circleci/README.md b/plugins/circleci/README.md index c96de56617..4802e8bee2 100644 --- a/plugins/circleci/README.md +++ b/plugins/circleci/README.md @@ -88,4 +88,4 @@ spec: ## Limitations - CircleCI has pretty strict rate limits per token, be careful with opened tabs -- CircelCI doesn't provide a way to auth by 3rd party (e.g. GitHub) token, nor by calling their OAuth endpoints, which currently stands in the way of better auth integration with Backstage (https://discuss.circleci.com/t/circleci-api-authorization-with-github-token/5356) +- CircleCI doesn't provide a way to auth by 3rd party (e.g. GitHub) token, nor by calling their OAuth endpoints, which currently stands in the way of better auth integration with Backstage (https://discuss.circleci.com/t/circleci-api-authorization-with-github-token/5356) From fe3619782bbbbe2cc5d4b2a2b0fca731315d88da Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Sun, 22 Nov 2020 20:57:40 -0500 Subject: [PATCH 3/4] Change entity YAML name --- .../scaffolder-backend/src/scaffolder/stages/templater/cra.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/templater/cra.ts b/plugins/scaffolder-backend/src/scaffolder/stages/templater/cra.ts index da33149c24..0fcd8a4f15 100644 --- a/plugins/scaffolder-backend/src/scaffolder/stages/templater/cra.ts +++ b/plugins/scaffolder-backend/src/scaffolder/stages/templater/cra.ts @@ -48,7 +48,7 @@ export class CreateReactAppTemplater implements TemplaterBase { }, }); - // Need to also make a component-info.yaml to store the data about the service. + // Need to also make a catalog-info.yaml to store the data about the service. const componentInfo = { apiVersion: 'backstage.io/v1alpha1', kind: 'Component', @@ -69,7 +69,7 @@ export class CreateReactAppTemplater implements TemplaterBase { ); await fs.promises.writeFile( - `${finalDir}/component-info.yaml`, + `${finalDir}/catalog-info.yaml`, yaml.stringify(componentInfo), ); From 5a1d8dca38ffa26303e8a9ab2bf02b214bb1eda7 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Sun, 22 Nov 2020 21:01:08 -0500 Subject: [PATCH 4/4] Add changeset --- .changeset/tidy-brooms-look.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/tidy-brooms-look.md diff --git a/.changeset/tidy-brooms-look.md b/.changeset/tidy-brooms-look.md new file mode 100644 index 0000000000..f2c2a9064e --- /dev/null +++ b/.changeset/tidy-brooms-look.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-scaffolder-backend': patch +--- + +Fix React entity YAML filename to new standard