Uh oh!
There was an error while loading. Please reload this page.
chore: update compass.yml — Jira board, status page, tier, lifecycle and metadata [PYSDK-82] - #570
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Atlassian Compass component definition for the Python SDK to enrich operational and ownership metadata (Jira board, status page, tier/lifecycle, and custom field population).
Changes:
- Added Compass links for the PYSDK Jira board and BetterStack status page.
- Updated component classification fields (tier, lifecycle, monorepo flag).
- Filled in previously empty Compass custom fields (component key, branches, external interfaces, deployability, repo path).
| - name: Deployment Branch | ||
| type: text | ||
| value: null | ||
| value: release/* |
There was a problem hiding this comment.
"Deployment Branch" is set to release/*, but this repo consistently uses the release/v* naming pattern for release branches (e.g., .github/workflows/ci-cd.yml triggers on release/v*, and CONTRIBUTING.md documents release/vX.Y.Z). Consider updating this value to release/v* to match the established convention.
| value: release/* | |
| value: release/v* |
| - name: Jira Board | ||
| type: PROJECT_TRACKER | ||
| url: https://aignx.atlassian.net/jira/software/projects/PYSDK/boards |
There was a problem hiding this comment.
The PR description says this link should point to the PYSDK Jira board, but the URL ends at /boards (board list) rather than a specific board (typically /boards/<boardId>). If the intent is a direct board link, update the URL to the concrete board URL so Compass users land on the intended board immediately.
| value: false | ||
| value: true | ||
| - name: Is open source | ||
| type: true |
There was a problem hiding this comment.
The custom field "Is open source" is malformed: it sets type: true (should be a valid Compass field type like boolean) and it doesn't provide a value. This will likely make the compass.yml invalid for Compass ingestion. Set type: boolean and add an explicit value: true/false (and keep the schema consistent with other boolean custom fields above).
| type: true | |
| type: boolean | |
| value: true |
Claude finished @helmut-hoffer-von-ankershoffen's task in 2m 48s —— View job Review Complete: PR #570 Compass Configuration UpdatesTodo List:
Review SummaryI've reviewed the Compass configuration changes and confirmed 3 blocking issues that must be fixed before merge. All issues were correctly identified by Copilot and verified against repository conventions. 🚨 BLOCKING ISSUES1. Incorrect Deployment Branch Pattern (Line 54)Issue: The deployment branch is set to Evidence from repository:
Location: Current: - name: Deployment Branchtype: textvalue: release/*Fix: - name: Deployment Branchtype: textvalue: release/v*2. Jira Board URL Points to Board List (Line 19)Issue: The URL points to the PYSDK project's board listing page instead of a specific board. Location: Current: - name: Jira Boardtype: PROJECT_TRACKERurl: https://aignx.atlassian.net/jira/software/projects/PYSDK/boardsExpected: A direct link to the specific board (e.g., Recommendation: Update to the specific board URL so users land directly on the PYSDK board, not the board list. 3. Malformed "Is open source" Custom Field (Lines 82-83)Issue: The custom field has incorrect structure:
Location: Current: - name: Is open sourcetype: trueFix (confirmed by LICENSE file - MIT license means it IS open source): - name: Is open sourcetype: booleanvalue: truePattern verification: All other boolean fields in this file follow this exact structure (e.g., "Has external API", "CSV Approved"). ✅ POSITIVE FINDINGS
📋 ACTION ITEMS FOR AUTHORTo fix all blocking issues:
Verify the fix: # Validate YAML syntax
uv run python -c "import yaml; yaml.safe_load(open('compass.yml'))"# Verify all boolean fields have correct structure
uv run python -c "import yaml, json; data = yaml.safe_load(open('compass.yml')); bools = [f for f in data['customFields'] if isinstance(f.get('type'), str) and f['type'] == 'boolean']; print(f'Found {len(bools)} boolean fields, all correctly structured')"📚 References
|
| value: false | ||
| value: true | ||
| - name: Is open source | ||
| type: true |
There was a problem hiding this comment.
The newly added custom field "Is open source" is malformed: it sets type: true (a boolean) and provides no value. This will likely fail Compass schema validation. Set type to the expected field type (e.g., boolean) and add an explicit value (true/false).
| type: true | |
| type: boolean | |
| value: true |
Uh oh!
There was an error while loading. Please reload this page.
🛡️ Implements PYSDK-82 following CC-SOP-01 Change Control, part of our ISO 13485-certified QMS | Ketryx Project
Summary
PROJECT_TRACKER) pointing to the PYSDK board in CompassSTATUS_PAGE) pointing to status.aignostics.comWhy
Enriches the Compass component catalog entry so the Python SDK is correctly classified, linked to its operational resources, and visible to on-call and platform teams.
Test plan
🤖 Generated with Claude Code