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

Merge pull request #3393 from adamdmharvey/doco-updates

Browse Source 
Fixes when referring to entity YAML filename to use new standard catalog-info.yaml
This commit is contained in:
Ben Lambert
2020-11-23 10:10:20 +01:00
committed by GitHub
parent f3ef9e28bf 5a1d8dca38
commit 09fde576c1
5 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/circleci/README.md
+2 -2
View File
@@ -61,7 +61,7 @@ proxy:
```
5. Get and provide `CIRCLECI_AUTH_TOKEN` as env variable (https://circleci.com/docs/api/#add-an-api-token)
6. Add `circleci.com/project-slug` annotation to your component-info.yaml file in format <git-provider>/<owner>/<project> (https://backstage.io/docs/architecture-decisions/adrs-adr002#format)
6. Add `circleci.com/project-slug` annotation to your catalog-info.yaml file in format <git-provider>/<owner>/<project> (https://backstage.io/docs/architecture-decisions/adrs-adr002#format)
```yaml
apiVersion: backstage.io/v1alpha1
@@ -88,4 +88,4 @@ spec:
## Limitations
- CircleCI has pretty strict rate limits per token, be careful with opened tabs
- CircelCI doesn't provide a way to auth by 3rd party (e.g. GitHub) token, nor by calling their OAuth endpoints, which currently stands in the way of better auth integration with Backstage (https://discuss.circleci.com/t/circleci-api-authorization-with-github-token/5356)
- CircleCI doesn't provide a way to auth by 3rd party (e.g. GitHub) token, nor by calling their OAuth endpoints, which currently stands in the way of better auth integration with Backstage (https://discuss.circleci.com/t/circleci-api-authorization-with-github-token/5356)
plugins/jenkins/README.md
+1 -1
View File
@@ -41,7 +41,7 @@ export JENKINS_BASIC_AUTH_HEADER="Basic $HEADER"
```
5. Run app with `yarn start`
6. Add the Jenkins folder annotation to your `component-info.yaml`, (note: currently this plugin only supports folders and Git SCM)
6. Add the Jenkins folder annotation to your `catalog-info.yaml`, (note: currently this plugin only supports folders and Git SCM)
```yaml
apiVersion: backstage.io/v1alpha1
plugins/scaffolder-backend/src/scaffolder/stages/templater/cra.ts
+1 -1
View File
@@ -48,7 +48,7 @@ export class CreateReactAppTemplater implements TemplaterBase {
},
});
// Need to also make a component-info.yaml to store the data about the service.
// Need to also make a catalog-info.yaml to store the data about the service.
const componentInfo = {
apiVersion: 'backstage.io/v1alpha1',
kind: 'Component',