Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
To better maintain our repositories, we are adding/updating
CODEOWNER
files andcatalog-info.yaml
to all repositories, where necessary. This will allow Backstage to detect all repositories and collate information to be used by our engineers.Required actions
The
catalog-info.yaml
file contains only basic information and can be expanded to better improve the usage of Backstage. Recommended additions include:circleci.com/project-slug
in theannotations
section to link to CircleCI (e.g.circleci.com/project-slug: github/Thinkei/clowne
)sonarqube.org/project-key
in theannotations
section to link to SonarQube (e.g.sonarqube.org/project-key: clowne
)datadoghq.com/dashboard-url
in theannotations
section to link to Datadog (e.g.datadoghq.com/dashboard-url: https://p.datadoghq.com/sb/abc-123-abc
). Note: The dashboard must be set to have a publicly visible link for this to work, please use caution when doing this to avoid potentially disclosing any sensitive information. See Backstage Datadog Plugin for more informationprovidesApis
link in the spec, and then referencing the OpenAPI docs in thekind: API
spec. Note: Backstage uses Swagger, which does not currently support OpenAPI 3.1, so either the docs need to be OpenAPI 3.0 or lower, or wait until OpenAPI 3.1 support is released later this yearThis Pull Request was automatically raised based on data believed to be correct. If this is incorrect, please modify the pull request to reflect who the owner should be or to make any amendments to the catalog file. Otherwise, please merge this pull request when convenient.
Thank you! If you have any questions or queries, please contact Chris Livett on Slack.