From 52bd59121d692fa9a343e2ba6f1564c8c3d9a1e3 Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Fri, 25 Aug 2023 17:13:07 +0200 Subject: [PATCH 1/2] Automate `catalog-info.yaml` file upkeep (pre-commit and CI) Signed-off-by: Eric Peterson --- .github/workflows/ci.yml | 3 +++ package.json | 7 +++++++ 2 files changed, 10 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 65844e339a..f6f5f4f79d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -98,6 +98,9 @@ jobs: - name: verify api reference run: node scripts/verify-api-reference.js + - name: verify catalog-info.yaml consistency + run: yarn backstage-repo-tools generate-catalog-info --ci + - name: lint openapi yaml files run: yarn backstage-repo-tools schema openapi lint diff --git a/package.json b/package.json index 6711d06f40..6bf5444b3b 100644 --- a/package.json +++ b/package.json @@ -96,6 +96,13 @@ "*.md": [ "node ./scripts/check-docs-quality" ], + "{plugins,packages}/*/catalog-info.yaml": [ + "yarn backstage-repo-tools generate-catalog-info --ci" + ], + "{.github/CODEOWNERS,package.json}": [ + "yarn backstage-repo-tools generate-catalog-info", + "git add */catalog-info.yaml" + ], "./yarn.lock": [ "node ./scripts/verify-lockfile-duplicates --fix" ], From dfbea4a71cd1f3109270224d73236dfb92a3fb45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Tue, 12 Sep 2023 13:26:52 +0200 Subject: [PATCH 2/2] current state MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- packages/app-next-example-plugin/catalog-info.yaml | 10 ++++++++++ packages/backend-plugin-manager/catalog-info.yaml | 10 ++++++++++ .../catalog-info.yaml | 12 ++++++++++++ .../catalog-info.yaml | 10 ++++++++++ 4 files changed, 42 insertions(+) create mode 100644 packages/app-next-example-plugin/catalog-info.yaml create mode 100644 packages/backend-plugin-manager/catalog-info.yaml create mode 100644 plugins/catalog-backend-module-scaffolder-entity-model/catalog-info.yaml create mode 100644 plugins/permission-backend-module-policy-allow-all/catalog-info.yaml diff --git a/packages/app-next-example-plugin/catalog-info.yaml b/packages/app-next-example-plugin/catalog-info.yaml new file mode 100644 index 0000000000..b89b43285a --- /dev/null +++ b/packages/app-next-example-plugin/catalog-info.yaml @@ -0,0 +1,10 @@ +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + name: app-next-example-plugin + title: app-next-example-plugin + description: Backstage internal example plugin +spec: + lifecycle: experimental + type: backstage-frontend-plugin + owner: maintainers diff --git a/packages/backend-plugin-manager/catalog-info.yaml b/packages/backend-plugin-manager/catalog-info.yaml new file mode 100644 index 0000000000..bc1845fe49 --- /dev/null +++ b/packages/backend-plugin-manager/catalog-info.yaml @@ -0,0 +1,10 @@ +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + name: backstage-backend-plugin-manager + title: '@backstage/backend-plugin-manager' + description: Backstage plugin management backend +spec: + lifecycle: experimental + type: backstage-node-library + owner: maintainers diff --git a/plugins/catalog-backend-module-scaffolder-entity-model/catalog-info.yaml b/plugins/catalog-backend-module-scaffolder-entity-model/catalog-info.yaml new file mode 100644 index 0000000000..6107adee5c --- /dev/null +++ b/plugins/catalog-backend-module-scaffolder-entity-model/catalog-info.yaml @@ -0,0 +1,12 @@ +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + name: backstage-plugin-catalog-backend-module-scaffolder-entity-model + title: '@backstage/plugin-catalog-backend-module-scaffolder-entity-model' + description: >- + Adds support for the scaffolder specific entity model (e.g. the Template + kind) to the catalog backend plugin. +spec: + lifecycle: experimental + type: backstage-backend-plugin-module + owner: maintainers diff --git a/plugins/permission-backend-module-policy-allow-all/catalog-info.yaml b/plugins/permission-backend-module-policy-allow-all/catalog-info.yaml new file mode 100644 index 0000000000..aa412acab4 --- /dev/null +++ b/plugins/permission-backend-module-policy-allow-all/catalog-info.yaml @@ -0,0 +1,10 @@ +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + name: backstage-plugin-permission-backend-module-allow-all-policy + title: '@backstage/plugin-permission-backend-module-allow-all-policy' + description: Allow all policy backend module for the permission plugin. +spec: + lifecycle: experimental + type: backstage-backend-plugin-module + owner: permission-maintainers