paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 28 Packages Projects Releases Wiki Activity

config,docs: switch to using url location type

Browse Source
This commit is contained in:
Patrik Oldsberg
2020-10-02 17:21:59 +02:00
parent b971534dfb
commit 238715aac2
8 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app-config.yaml
+5 -5
View File
@@ -124,19 +124,19 @@ catalog:
locations:
# Backstage example components
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/all-components.yaml
# Example component for github-actions
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/plugins/github-actions/examples/sample.yaml
# Example component for techdocs
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/plugins/techdocs-backend/examples/documented-component/documented-component.yaml
# Backstage example APIs
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/all-apis.yaml
# Backstage example templates
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/all-templates.yaml
scaffolder:
docs/features/software-catalog/configuration.md
+2 -2
View File
@@ -74,7 +74,7 @@ the catalog under the `catalog.locations` key, for example:
```yaml
catalog:
locations:
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/artist-lookup-component.yaml
```
@@ -97,7 +97,7 @@ catalog:
- allow: [Component, API, Location, Template]
locations:
- type: github
- type: url
target: https://github.com/org/example/blob/master/org-data.yaml
rules:
- allow: [Group]
docs/features/software-catalog/index.md
+1 -1
View File
@@ -90,7 +90,7 @@ above example can be added using the following configuration:
```yaml
catalog:
locations:
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/artist-lookup-component.yaml
```
docs/features/software-catalog/installation.md
+8 -8
View File
@@ -166,21 +166,21 @@ our example templates through static configuration. Add the following to the
catalog:
locations:
# Backstage Example Component
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/artist-lookup-component.yaml
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/playback-order-component.yaml
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/podcast-api-component.yaml
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/queue-proxy-component.yaml
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/searcher-component.yaml
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/playback-lib-component.yaml
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/www-artist-component.yaml
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/shuffle-api-component.yaml
```
docs/features/software-templates/adding-templates.md
+1 -1
View File
@@ -66,7 +66,7 @@ for example
```yaml
catalog:
locations:
- type: github
- type: url
target: https://github.com/spotify/cookiecutter-golang/blob/master/template.yaml
rules:
- allow: [Template]
docs/features/software-templates/installation.md
+4 -4
View File
@@ -191,13 +191,13 @@ our example templates through static configuration. Add the following to the
catalog:
locations:
# Backstage Example Templates
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/springboot-grpc-template/template.yaml
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/create-react-app/template.yaml
- type: github
- type: url
target: https://github.com/spotify/cookiecutter-golang/blob/master/template.yaml
```
packages/create-app/templates/default-app/app-config.yaml.hbs
+7 -7
View File
@@ -82,31 +82,31 @@ catalog:
# env: GHE_PRIVATE_TOKEN
locations:
# Backstage example components
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/all-components.yaml
# Backstage example APIs
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/all-apis.yaml
# Backstage example templates
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml
rules:
- allow: [Template]
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/springboot-grpc-template/template.yaml
rules:
- allow: [Template]
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/create-react-app/template.yaml
rules:
- allow: [Template]
- type: github
- type: url
target: https://github.com/spotify/cookiecutter-golang/blob/master/template.yaml
rules:
- allow: [Template]
- type: github
- type: url
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/docs-template/template.yaml
rules:
- allow: [Template]
plugins/catalog-backend/src/ingestion/CatalogRules.ts
+2 -2
View File
@@ -74,11 +74,11 @@ export class CatalogRulesEnforcer {
* - allow: [Component, API]
*
* locations:
* - type: github
* - type: url
* target: https://github.com/org/repo/blob/master/users.yaml
* rules:
* - allow: [User, Group]
* - type: github
* - type: url
* target: https://github.com/org/repo/blob/master/systems.yaml
* rules:
* - allow: [System]