Simplify Setup #1888
Open
Simplify Setup #1888
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Links: |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
This is an automated PR from the Simplify team,
more information available here.
Colophon is being deprecated!
Context: Over the last 6 months the Simplify team has been experimenting with a fresh version of Backstage that's centred around Software Catalog. This means that we will no longer need colophon files (however we recommend keeping it until we announce all their dependencies are removed).
What does this Pull Request do?
This PR copies the existing contents of your colophon file and creates a new
catalog-info.yamlfile, which is then picked up by Simplify and places this repository in the software catalog. No other changes are made to your repository, and your colophon file is left intact.In the future, we will announce the finalized deprecation of Colophon. At that time, expect another automated PR from us removing your colophon file once it is safe to do so.
Why do you want to do this?
Our goal is to make things easier to find, make actions on your repos take less time to do, and provide insights into the things that you need to know in order to do your jobs effectively.
Software Catalog is the basis for Backstage (Simplify). By adding your catalog-info into your repo (in the pull request that likely took you here) you will be registered automatically in the catalog. This unlocks a lot of features in Backstage that you will be able to take advantage of, including:
What do we need from you?
All you need to do is merge this PR and your repo will be picked up automatically!
If you want to take advantage of some of the other features of Backstage, you will require some additional config in your yaml file (but this is a one time thing!). Here are more instructions on how to do that.
We also recommend setting up a GitHub
CODEOWNERSfile (instructions here). This is used to to set ownership of your repo in our portal.If you have more questions reach out in #simplify-hub and we'll be happy to help you out.
Happy coding!
-- The Simplify Team 🚀