Merge pull request #1759 from spotify/ndudnik/github-actions-annotation

fix: annotation name
This commit is contained in:
Nikita Dudnik
2020-07-28 09:58:47 +02:00
committed by GitHub
3 changed files with 5 additions and 6 deletions
+3 -2
View File
@@ -15,7 +15,7 @@ TBD
2. Take Client ID and Client Secret from the newly created app's settings page and put them into `AUTH_GITHUB_CLIENT_ID` and `AUTH_GITHUB_CLIENT_SECRET` env variables.
2. Annotate your component with a correct GitHub Actions repository and owner:
The annotation key is `backstage.io/github-actions-id`.
The annotation key is `github.com/project-slug`.
Example:
@@ -26,7 +26,8 @@ TBD
name: backstage
description: backstage.io
annotations:
backstage.io/github-actions-id: 'spotify/backstage'
github.com/project-slug: 'spotify/backstage'
spec:
type: website
lifecycle: production
+1 -1
View File
@@ -4,7 +4,7 @@ metadata:
name: backstage
description: backstage.io
annotations:
backstage.io/github-actions-id: 'spotify/backstage'
github.com/project-slug: 'spotify/backstage'
spec:
type: website
lifecycle: production
@@ -23,9 +23,7 @@ export const useProjectName = (name: EntityCompoundName) => {
const { value } = useAsync<string>(async () => {
const entity = await catalogApi.getEntityByName(name);
return (
entity?.metadata.annotations?.['backstage.io/github-actions-id'] ?? ''
);
return entity?.metadata.annotations?.['github.com/project-slug'] ?? '';
});
return value;
};