Skip to content

Commit

Permalink
Switch to using file locations in app-config.yaml
Browse files Browse the repository at this point in the history
Having file locations makes the local workflow of editing entities, e.g. for testing much easier. When you add new files, you don't run into a circular dependency anymore, previously you couldn't test whether the configuration worked before merging it into master. It also resolves the hard dependency on the GitHub repository - which allows to do "breaking changes" to the files without having to worry that existing instances used for development locally will break. However after this change we should have a grace period in that we should still be careful.

However there might be hidden risks that might break others workflows.

We have this configuration locally for a long time and it works well.
  • Loading branch information
Fox32 committed Jan 20, 2021
1 parent 7abe2c2 commit 50aa92a
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions app-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -185,33 +185,35 @@ catalog:
# groupFilter: securityEnabled eq false and mailEnabled eq true and groupTypes/any(c:c+eq+'Unified')

locations:
# File locations are relative to the current working directory of the
# backend, for example packages/backend/.
# Backstage example components
- type: url
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-components.yaml
- type: file
target: ../catalog-model/examples/all-components.yaml
# Example component for github-actions
- type: url
target: https://github.com/backstage/backstage/blob/master/plugins/github-actions/examples/sample.yaml
- type: file
target: ../../plugins/github-actions/examples/sample.yaml
# Example component for TechDocs
- type: url
target: https://github.com/backstage/backstage/blob/master/plugins/techdocs-backend/examples/documented-component/catalog-info.yaml
- type: file
target: ../../plugins/techdocs-backend/examples/documented-component/catalog-info.yaml
# Backstage example APIs
- type: url
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-apis.yaml
- type: file
target: ../catalog-model/examples/all-apis.yaml
# Backstage example resources
- type: url
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-resources.yaml
- type: file
target: ../catalog-model/examples/all-resources.yaml
# Backstage example systems
- type: url
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-systems.yaml
- type: file
target: ../catalog-model/examples/all-systems.yaml
# Backstage example domains
- type: url
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-domains.yaml
- type: file
target: ../catalog-model/examples/all-domains.yaml
# Backstage example templates
- type: url
target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/all-templates.yaml
- type: file
target: ../../plugins/scaffolder-backend/sample-templates/all-templates.yaml
# Backstage example groups and users
- type: url
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme-corp.yaml
- type: file
target: ../catalog-model/examples/acme-corp.yaml

scaffolder:
github:
Expand Down

0 comments on commit 50aa92a

Please sign in to comment.