From 153d4f866aa8f9d3eb1725477159f3cf07f7e22e Mon Sep 17 00:00:00 2001 From: Tianyi Song <42670338+tysng@users.noreply.github.com> Date: Wed, 7 Oct 2020 15:05:22 +0800 Subject: [PATCH] feat(create-app): add catalog-info.yaml in the created app (#2759) * Add template for catalog-info * Update docs --- docs/getting-started/create-an-app.md | 4 ++++ .../templates/default-app/catalog-info.yaml.hbs | 13 +++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 packages/create-app/templates/default-app/catalog-info.yaml.hbs diff --git a/docs/getting-started/create-an-app.md b/docs/getting-started/create-an-app.md index 831e8af145..9be0e24452 100644 --- a/docs/getting-started/create-an-app.md +++ b/docs/getting-started/create-an-app.md @@ -74,6 +74,7 @@ app. ``` app ├── app-config.yaml +├── catalog-info.yaml ├── lerna.json ├── package.json └── packages @@ -83,6 +84,9 @@ app - **app-config.yaml**: Main configuration file for the app. See [Configuration](https://backstage.io/docs/conf/) for more information. +- **catalog-info.yaml**: Catalog Entities descriptors. See + [Descriptor Format of Catalog Entities](https://backstage.io/docs/features/software-catalog/descriptor-format) + to get started. - **lerna.json**: Contains information about workspaces and other lerna configuration needed for the monorepo setup. - **package.json**: Root package.json for the project. _Note: Be sure that you diff --git a/packages/create-app/templates/default-app/catalog-info.yaml.hbs b/packages/create-app/templates/default-app/catalog-info.yaml.hbs new file mode 100644 index 0000000000..a370902020 --- /dev/null +++ b/packages/create-app/templates/default-app/catalog-info.yaml.hbs @@ -0,0 +1,13 @@ +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + name: {{name}} + description: An example of a Backstage application. + # Example for optional annotations + # annotations: + # github.com/project-slug: spotify/backstage + # backstage.io/techdocs-ref: github:https://github.com/spotify/backstage.git +spec: + type: website + owner: john@example.com + lifecycle: experimental \ No newline at end of file