Allow a domain entity to have an optional domain #17125

dawngerpony · 2023-03-27T16:59:34Z

For large organisations, a hierarchy of domains might make life easier. This PR introduces an optional domain field into the Domain entity so that a domain can have a parent domain.

Hey, I just made a Pull Request!

✔️ Checklist

A changeset describing the change and affected packages. (more info)
Added or updated documentation
Tests for new functionality and regression tests for bug fixes
~~Screenshots attached (for UI changes)~~
All your commits have a Signed-off-by line in the message. (more info)

backstage-goalie · 2023-03-27T17:00:01Z

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
@backstage/catalog-model	packages/catalog-model	minor	`v1.4.5`
@backstage/plugin-catalog-backend	plugins/catalog-backend	minor	`v1.21.1`

backstage-goalie · 2023-03-27T17:00:41Z

Thanks for the contribution!
All commits need to be DCO signed before they are reviewed. Please refer to the the DCO section in CONTRIBUTING.md or the DCO status for more info.

github-actions · 2023-03-27T17:12:05Z

Uffizzi Ephemeral Environment `deployment-20442`

☁️ https://app.uffizzi.com/github.com/backstage/backstage/pull/17125

📄 View Application Logs etc.

What is Uffizzi? Learn more!

github-actions · 2023-04-03T18:05:41Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

freben

Hi! One thing that's missing here is the corresponding update to the corresponding processor.

freben · 2023-04-05T12:56:46Z

packages/catalog-model/src/schema/kinds/Domain.v1alpha1.schema.json

+            },
+            "domain": {
+              "type": "string",
+              "description": "An entity reference to the domain that the system belongs to.",


Need to adjust the wording here

freben · 2023-04-05T12:58:42Z

Ping @backstage/catalog-core

freben · 2023-04-05T13:03:00Z

docs/features/software-catalog/descriptor-format.md

@@ -1240,6 +1240,7 @@ metadata:
  description: Everything about artists
 spec:
  owner: artist-relations-team
+  domain: audio-domain


There are more details about the specific fields and their semantics nearby. Need to add that with the appropriate table just like other relations, explaining that the default kind is Domain and the default namespace is the same as this same domain etc.

Also might want to adjust well-known relations to mention the Domain kind around the intended relations.

Also, you call this domain. Another candidate would have been parent. Are you avoiding that since you intend to not use the parentOf/childOf relations?

github-actions · 2023-04-12T13:08:54Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

github-actions · 2023-04-20T11:33:44Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

freben · 2023-04-20T13:06:20Z

Pinging @backstage/catalog-maintainers here again

github-actions · 2023-04-27T13:07:43Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

github-actions · 2023-05-04T14:35:05Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

github-actions · 2023-05-11T21:16:08Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

dawngerpony · 2024-04-09T14:14:02Z

hey @freben, I think this PR is now ready for re-review! Thank you to @janogonzalez for going the last mile and finishing off my work properly 🙏

freben · 2024-04-09T15:13:02Z

plugins/catalog-backend/src/modules/core/BuiltinKindsEntityProcessor.ts

+        { defaultKind: 'Domain', defaultNamespace: selfRef.namespace },
+        RELATION_PART_OF,
+        RELATION_HAS_PART,
+      );


this does need an additional changeset to get shipped

Noted, CC @janogonzalez

plugins/catalog-backend/src/modules/core/BuiltinKindsEntityProcessor.ts

… be represented. Signed-off-by: Dawn James <dawnj@spotify.com>

Signed-off-by: Dawn James <dawnj@spotify.com>

Signed-off-by: Jano González <info@janogonzalez.com> Signed-off-by: Dawn James <dawnj@spotify.com>

Signed-off-by: Dawn James <dawnj@spotify.com>

Signed-off-by: Jano González <info@janogonzalez.com> Signed-off-by: Dawn James <dawnj@spotify.com>

freben

Nice. Would love for @backstage/catalog-maintainers to sign off too

docs/features/software-catalog/descriptor-format.md

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

github-actions · 2024-04-22T15:36:16Z

Thank you for contributing to Backstage! The changes in this pull request will be part of the 1.27.0 release, scheduled for Tue, 14 May 2024.

github-actions bot added area:catalog Related to the Catalog Project Area documentation Improvements or additions to documentation labels Mar 27, 2023

dawngerpony changed the title ~~Allow a domain entity to have a domain so that a domain hierarchy can…~~ Allow a domain entity to have an optional domain Mar 27, 2023

dawngerpony force-pushed the dawngerpony/parent-domain-v1 branch from 2ebd7f8 to 5343e62 Compare March 27, 2023 17:31

github-actions bot added the stale label Apr 3, 2023

dawngerpony marked this pull request as ready for review April 5, 2023 12:40

dawngerpony requested a review from a team as a code owner April 5, 2023 12:40

dawngerpony requested a review from freben April 5, 2023 12:40

github-actions bot removed the stale label Apr 5, 2023

freben reviewed Apr 5, 2023

View reviewed changes

github-actions bot added the stale label Apr 12, 2023

freben removed the stale label Apr 13, 2023

github-actions bot added the stale label Apr 20, 2023

freben removed the stale label Apr 20, 2023

github-actions bot added the stale label Apr 27, 2023

freben removed the stale label Apr 27, 2023

github-actions bot added the stale label May 4, 2023

freben removed the stale label May 4, 2023

github-actions bot removed search Things related to Search area:scaffolder Everything and all things related to the scaffolder project area area:permission Related to the Permission Project Area area:discoverability Related to the Discoverability Project Area labels Apr 9, 2024

freben reviewed Apr 9, 2024

View reviewed changes

kuangp removed their request for review April 10, 2024 13:07

dawngerpony mentioned this pull request Apr 11, 2024

Add changeset for plugin-catalog-backend dawngerpony/backstage#4

Merged

dawngerpony requested review from freben and janogonzalez April 11, 2024 12:19

freben mentioned this pull request Apr 15, 2024

Move out the default entity model into its own module #23350

Closed

janogonzalez approved these changes Apr 17, 2024

View reviewed changes

dawngerpony and others added 10 commits April 17, 2024 16:45

Allow a domain entity to have a domain so that a domain hierarchy can…

cbcfa72

… be represented. Signed-off-by: Dawn James <dawnj@spotify.com>

Add a changeset and update docs.

79025f3

Signed-off-by: Dawn James <dawnj@spotify.com>

yarn build:api-reports

8d96b58

Signed-off-by: Dawn James <dawnj@spotify.com>

Change parent domain attribute to subdomainOf

645668a

Signed-off-by: Jano González <info@janogonzalez.com> Signed-off-by: Dawn James <dawnj@spotify.com>

Generate relations for subdomainOf

889b017

Signed-off-by: Jano González <info@janogonzalez.com> Signed-off-by: Dawn James <dawnj@spotify.com>

Document subdomainOf attribute

a8a21fa

Signed-off-by: Jano González <info@janogonzalez.com> Signed-off-by: Dawn James <dawnj@spotify.com>

run yarn build:api-reports

4ba5aa6

Signed-off-by: Dawn James <dawnj@spotify.com>

Fix descriptor format for domain

593a773

Signed-off-by: Jano González <info@janogonzalez.com> Signed-off-by: Dawn James <dawnj@spotify.com>

Update well known relations doc

ba7bd1b

Signed-off-by: Jano González <info@janogonzalez.com> Signed-off-by: Dawn James <dawnj@spotify.com>

Add changeset for plugin-catalog-backend

8d14475

Signed-off-by: Jano González <info@janogonzalez.com> Signed-off-by: Dawn James <dawnj@spotify.com>

dawngerpony force-pushed the dawngerpony/parent-domain-v1 branch from 07121b5 to 8d14475 Compare April 17, 2024 15:46

benjdlambert removed their request for review April 22, 2024 08:39

freben approved these changes Apr 22, 2024

View reviewed changes

docs/features/software-catalog/descriptor-format.md Outdated Show resolved Hide resolved

Update docs/features/software-catalog/descriptor-format.md

a2ce77a

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

hntrdglss approved these changes Apr 22, 2024

View reviewed changes

freben merged commit 910d725 into backstage:master Apr 22, 2024
29 of 30 checks passed

vinzscam mentioned this pull request May 13, 2024

docs: hierarchy of domains #24752

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow a domain entity to have an optional domain #17125

Allow a domain entity to have an optional domain #17125

dawngerpony commented Mar 27, 2023 •

edited

Loading

backstage-goalie bot commented Mar 27, 2023 •

edited

Loading

backstage-goalie bot commented Mar 27, 2023

github-actions bot commented Mar 27, 2023 •

edited

Loading

github-actions bot commented Apr 3, 2023

freben left a comment

freben Apr 5, 2023

freben commented Apr 5, 2023

freben Apr 5, 2023

github-actions bot commented Apr 12, 2023

github-actions bot commented Apr 20, 2023

freben commented Apr 20, 2023

github-actions bot commented Apr 27, 2023

github-actions bot commented May 4, 2023

github-actions bot commented May 11, 2023

dawngerpony commented Apr 9, 2024

freben Apr 9, 2024

dawngerpony Apr 9, 2024

freben left a comment

github-actions bot commented Apr 22, 2024

Allow a domain entity to have an optional domain #17125

Allow a domain entity to have an optional domain #17125

Conversation

dawngerpony commented Mar 27, 2023 • edited Loading

Hey, I just made a Pull Request!

✔️ Checklist

backstage-goalie bot commented Mar 27, 2023 • edited Loading

Changed Packages

backstage-goalie bot commented Mar 27, 2023

github-actions bot commented Mar 27, 2023 • edited Loading

Uffizzi Ephemeral Environment deployment-20442

github-actions bot commented Apr 3, 2023

freben left a comment

Choose a reason for hiding this comment

freben Apr 5, 2023

Choose a reason for hiding this comment

freben commented Apr 5, 2023

freben Apr 5, 2023

Choose a reason for hiding this comment

github-actions bot commented Apr 12, 2023

github-actions bot commented Apr 20, 2023

freben commented Apr 20, 2023

github-actions bot commented Apr 27, 2023

github-actions bot commented May 4, 2023

github-actions bot commented May 11, 2023

dawngerpony commented Apr 9, 2024

freben Apr 9, 2024

Choose a reason for hiding this comment

dawngerpony Apr 9, 2024

Choose a reason for hiding this comment

freben left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 22, 2024

dawngerpony commented Mar 27, 2023 •

edited

Loading

backstage-goalie bot commented Mar 27, 2023 •

edited

Loading

github-actions bot commented Mar 27, 2023 •

edited

Loading

Uffizzi Ephemeral Environment `deployment-20442`