What's new in Roadie
This is the changelog for Roadie. It lists new and updated features so you can get a quick overview of what's new. You can follow us on Twitter for more updates.
From today, we have released an improvement to ensure that Backstage metadata files will be found and validated regardless of their name or location in the codebase.
Roadie’s GitHub app automatically checks your Backstage metadata YAML files for syntactic correctness. This helps you to catch problems which may prevent your components from showing up in Backstage.
These files are typically named
catalog-info.yamland are often located in the root of a repository. However, users using monorepos frequently have these catalog-info.yaml files distributed throughout the monorepo. In these cases, the GitHub app validator would fail to find or validate the files. This is no longer the case.
Today we have enabled the Tech Insights Scorecard. You can add it to a component page to see a couple of example checks that we have enabled on your behalf. We want to continue to build on this feature in the coming weeks. Please let us know if you have any comments on this feature.
We’ve released a recent version of Backstage: 2021-12-09
The main user facing changes are:
- The Kubernetes plugin has been improved to show jobs and cronjobs.
- The techdocs experience has improved read performance.
Ever been stuck waiting for a Component to re-import so you can see if you fixed that syntax error in you
We’ve been there. The locations log now has a manual refresh button so you can check for updates on your terms.
We have noticed that getting the catalog info file right is difficult. Small syntax errors can mean that the
catalog-info.yamlfile doesn’t appear in Backstage at all. This leads to frustrating hours lost to debugging.
From now on, pull requests which edit
catalog-info.yamlfiles will be checked for errors before they make their way to Roadie Backstage. This will allow you to detect errors in your catalog file before they are even deployed.
We have noticed it is sometimes challenging to understand which card displays a specific error in the Overview tab.
Now the name of the card is clearly visible in edit mode to help you debug the problem.
We discovered that large monorepos would sometimes fail to import in to Roadie Backstage.
There were 2 problems:
- Sufficiently large monorepos would hit a timeout while being analyzed for problems before import.
- Monorepos could contain circular references in their
Locationmetadata files, leading to timoouts during import.
These issues are now fixed.
We also published a blog post explaining how to work with monorepos in Backstage.
We’ve released a recent version of Backstage: 2021-11-12
The main user facing changes are:
- The “View API” button on the “About” card for entities has been removed in favour of users navigating to the API tab directly.
- The search modal is now available.
catalog-info.yamlmetadata for a entity is deleted, it’s possible for the entity to end up in an “orphaned” stage in Backstage.
Backstage now warns you when this happens, and gives you a way to clean up the entity.
FireHydrant is an incident management tool with a variety of reliability management features including its own service catalog. Backstage components can be added to the FireHydrant service catalog.
The FireHydrant plugin is now available in Roadie. Visit our docs to learn how to use it.
We’ve also made the Catalog Graph plugin available from today. The Catalog Graph plugin shows relationships between entities in your catalog.