question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[Catalog] Importing conflicting entities should result in an error

See original GitHub issue

Expected Behavior

Our teams register catalogs in Backstage via tagged sources for version controlling the documentation.

A catalog was initially registered from a certain tag (say v1.0.0). This version offers certain code and its associated TechDocs.

A new version from another is now registered (without unregistering the previous version).

Ideally, Backstage should show warning/errors during the Analysis phase of the Catalog Import process if both catalogs are using the same [namespace]/[name].

We should then un-register the previous catalog and register via a new source (would be great if a method for making this switch more efficient and automatic exists/can be developed).

Actual Behavior

The catalog from the newly tagged location passes the analysis phase and we can Import it to see its the new location is registered. But in reality, the catalog showcases information about the previously registered tag and we can view this in Inspect Element as well.

Steps to Reproduce

  1. Tag your Catalog Repository and register it within Backstage from the tagged location.

https://gitlab.com/[namespace]/[name]/-/blob/1.0.0/catalog-info.yaml

Screenshot 2022-04-16 at 8 42 20 PM
  1. Make relevant changes to the repository (TechDocs, other catalog metadata, etc. but keeping the metadata.name intact) and tag the repository again.

https://gitlab.com/[namespace]/[name]/-/blob/1.1.0/catalog-info.yaml

Screenshot 2022-04-16 at 8 43 21 PM
  1. Register the catalog Backstage from the newly tagged location.

  2. Backstage showcases information of the previously tagged catalog instead of the latest and doesn’t even give warning/errors while registering an already existing catalog from a new source.

Screenshot 2022-04-16 at 8 44 16 PM

Context

The issue affects us given the catalog management becomes tedious and we can have a false sense of documentation and code being showcased in Backstage is the latest. For example, v1.0.0 docs are shown because we thought the v1.0.1 catalog is successfully registered.

Your Environment

  • Browser Information: Google Chrome 97.0.4692.99

  • Backstage v1.0.3

Issue Analytics

  • State:open
  • Created a year ago
  • Comments:9 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
Rugvipcommented, Apr 19, 2022

Yep this doesn’t seem like we’re doing enough checks to highlight conflicts. I’ll retitle the issue to focus on that.

On a separate note, are you managing documentation versions through registering entities on different tags? That does seem like a bit of a pain tbh 😅 . Is it for APIs/TechDocs/something else?

0reactions
github-actions[bot]commented, Dec 10, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Read more comments on GitHub >

github_iconTop Results From Across the Web

99+ WooCommerce Import Errors And How to Fix Them
Most often import would fail because a CSV file is missing some data or contains incompatible data. What you can do for the...
Read more >
Child Conflict in one of these Attributes" when Importing Item
Symptoms. Import Price Catalog is erroring when importing documents with new items to be assigned to child inventory organizations. TABLE NAME : ...
Read more >
Data management error descriptions - Finance & Operations
This article describes the error messages that you might encounter in data management.
Read more >
import already defined in single type import
In Java, you cannot import two different classes with the same name. In these situations, you can import one, but use the other...
Read more >
Possible errors | Migrating photos to Lightroom
Error : Some files have metadata conflicts. Some of your files in Lightroom Classic have data on disk that doesn't match the catalog....
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found