Skip to content

Updating factbook.yaml to get factbook_compliant in Policy Engine #57

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.

Sign up for GitHub

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

Open
medidata wants to merge 1 commit into
base: main
Choose a base branch
from
+31 −0
Open

Updating factbook.yaml to get factbook_compliant in Policy Engine #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions factbook.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
json_schema: https://github.com/mdsol/platform-standards/blob/main/schemas/v1alpha1.schema.json
name: FIX_REQUIRED_NAME
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metadata.name is still set to FIX_REQUIRED_NAME. Policy/Backstage identifiers typically need to be a stable, lowercase slug (and this placeholder will likely fail validation/compliance). Please replace it with the actual component name used for this repo.

Suggested change
name: FIX_REQUIRED_NAME
name: mauth

Copilot uses AI. Check for mistakes.
description: FIX_REQUIRED_DESCRIPTION
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metadata.description is still FIX_REQUIRED_DESCRIPTION. Please replace this placeholder with an accurate, human-readable description of the component/repo so the catalog entry is meaningful and passes any required-field checks.

Suggested change
description: FIX_REQUIRED_DESCRIPTION
description: Backstage catalog entry for the Platform mauth component managed by Team 248.

Copilot uses AI. Check for mistakes.
people:
- role: technical owner
email: ykitamura@mdsol.com
- role: product owner
email: Not Found in Factbook
Comment on lines +10 to +11
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

email: Not Found in Factbook is not a valid email address and will likely break schema validation/automations that expect an email. Please provide the actual product owner email, or remove this person entry until the correct value is known.

Suggested change
- role: product owner
email: Not Found in Factbook

Copilot uses AI. Check for mistakes.
teams:
- number: 248
name: Team 248
annotations:
runbook: No runbook found
healthcheck: NO HEALTH CHECK
Comment on lines +16 to +17
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

annotations.runbook and annotations.healthcheck are set to free-text placeholders (No runbook found, NO HEALTH CHECK). If consumers expect URLs (common for these fields), this can break linking/health tooling. Prefer omitting these keys when unavailable, or set them to the actual runbook/healthcheck URLs.

Suggested change
runbook: No runbook found
healthcheck: NO HEALTH CHECK

Copilot uses AI. Check for mistakes.
product: Platform mauth
channels:
- url: FIX_REQUIRED_CHANNEL_URL
role: slack
automated_messaging: true
mention: FIX_REQUIRED_SLACK_MENTION
- url: FIX_REQUIRED_EMAIL_CHANNEL_URL
role: email
automated_messaging: false
Comment on lines +19 to +26
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Channel fields still contain placeholders (FIX_REQUIRED_CHANNEL_URL, FIX_REQUIRED_SLACK_MENTION, FIX_REQUIRED_EMAIL_CHANNEL_URL). These will likely fail compliance checks and prevent automated messaging from working. Please update to the real Slack channel URL/mention and a valid email distribution list (or remove the channel entries if not applicable).

Suggested change
channels:
- url: FIX_REQUIRED_CHANNEL_URL
role: slack
automated_messaging: true
mention: FIX_REQUIRED_SLACK_MENTION
- url: FIX_REQUIRED_EMAIL_CHANNEL_URL
role: email
automated_messaging: false

Copilot uses AI. Check for mistakes.
spec:
type: FIX_TYPE
lifecycle: FIX_REQUIRED_LIFECYCLE
owner: FIX_REQUIRED_OWNER
Comment on lines +28 to +30
Copy link

Copilot AI Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spec.type, spec.lifecycle, and spec.owner are still placeholders (FIX_TYPE, FIX_REQUIRED_LIFECYCLE, FIX_REQUIRED_OWNER). If Policy Engine validates these, the repo will remain non-compliant. Please populate these with the correct values (and ensure owner matches the expected Backstage entity reference format for your org, if applicable).

Suggested change
type: FIX_TYPE
lifecycle: FIX_REQUIRED_LIFECYCLE
owner: FIX_REQUIRED_OWNER
type: service
lifecycle: production
owner: group:default/team-248

Copilot uses AI. Check for mistakes.
experience: enablement
Loading