Merge pull request #4973 from backstage/timbonicus/add-example-org

Add example org entities to default create-app
backstage · Mar 17, 2021 · 98e95f7 · 98e95f7
2 parents a0098ba + 0283392
commit 98e95f7
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/.changeset/short-olives-mate.md b/.changeset/short-olives-mate.md
@@ -0,0 +1,22 @@
+---
+'@backstage/create-app': patch
+---
+
+Adds example groups and users to the default app template.
+
+To apply this change in an existing application, change the following in `app-config.yaml`:
+
+```diff
+     - type: url
+       target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-apis.yaml
+
++    # Backstage example organization groups
++    - type: url
++      target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/org.yaml
++      rules:
++        - allow: [Group, User]
++
+     # Backstage example templates
+     - type: url
+       target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml
+```
diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs
@@ -89,6 +89,12 @@ catalog:
     - type: url
       target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-apis.yaml
 
+    # Backstage example organization groups
+    - type: url
+      target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/org.yaml
+      rules:
+        - allow: [Group, User]
+
     # Backstage example templates
     - type: url
       target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml