Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify Setup #1888

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Simplify Setup #1888

wants to merge 1 commit into from

Conversation

nateaxcell
Copy link

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.yaml file, 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 CODEOWNERS file (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 🚀

@github-actions
Copy link

Links:

Packages pending updates:


If this is not what you expected, ensure that your commit messages follow the TDS commit types guide on this page: https://tds.telus.com/contributing/developer-guide.html and try again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant