Skip to content

chore: fix link types and add missing Ketryx link in compass.yml [PYSDK-88]#576

Merged
helmut-hoffer-von-ankershoffen merged 2 commits into
mainfrom
chore/PYSDK-88-compass-dashboard-links
Apr 24, 2026
Merged

chore: fix link types and add missing Ketryx link in compass.yml [PYSDK-88]#576
helmut-hoffer-von-ankershoffen merged 2 commits into
mainfrom
chore/PYSDK-88-compass-dashboard-links

Conversation

@helmut-hoffer-von-ankershoffen
Copy link
Copy Markdown
Contributor

@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen commented Apr 24, 2026

🛡️ Implements PYSDK-88 following CC-SOP-01 Change Control, part of our ISO 13485-certified QMS | Ketryx Project

Summary

  • Status Page: OTHER_LINKDASHBOARD (uptime/reliability KPIs)
  • Sentry: OTHER_LINKDASHBOARD (observability — fits Compass "KPIs, observability, or usage")
  • Add missing Ketryx Project OTHER_LINK — required by SW-SOP-01 but absent from main
  • Fix Jira board URL: /boards/boards/1799 (classic projects require the numeric board ID; the generic /boards path returns 404)

Why

The Compass UI describes Dashboards as "Add dashboards for KPIs, observability, or usage". Both the BetterStack Status Page (uptime/reliability metrics) and Sentry (error observability) fit this better than Other Links.

The Ketryx link was dropped when PYSDK-85's fix branch did not carry it forward after merge.

The Jira board URL /jira/software/c/projects/PYSDK/boards returns 404 — the working URL is /jira/software/c/projects/PYSDK/boards/1799.

Test plan

  • CI green
  • After merge: Compass shows Status Page and Sentry under Dashboards
  • Ketryx Project link appears under Other Links
  • Jira Board link opens correctly at /boards/1799
  • No "compass.yml sync failed" banner

Copilot AI review requested due to automatic review settings April 24, 2026 18:09
@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen added the skip:test:long_running Skip long-running tests (≥5min) label Apr 24, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the Atlassian Compass component metadata for the Python SDK to better categorize observability links and restore the required Ketryx project link.

Changes:

  • Reclassifies “Status Page” link type from OTHER_LINK to DASHBOARD.
  • Adds missing “Ketryx Project” link as OTHER_LINK.
  • Reclassifies “Sentry” link type from OTHER_LINK to DASHBOARD.

@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen marked this pull request as ready for review April 24, 2026 18:11
@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen requested a review from a team as a code owner April 24, 2026 18:11
@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen merged commit 2db76b2 into main Apr 24, 2026
19 of 21 checks passed
@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen deleted the chore/PYSDK-88-compass-dashboard-links branch April 24, 2026 18:11
@sonarqubecloud
Copy link
Copy Markdown

@claude
Copy link
Copy Markdown

claude Bot commented Apr 24, 2026

Claude finished @helmut-hoffer-von-ankershoffen's task in 2m 35s —— View job


Review Complete ✅

Note: This PR is already merged. Providing retrospective review feedback.

Todo List

  • Read compass.yml file
  • Review git diff to see what changed
  • Verify changes match PR description
  • Assess link type reclassifications
  • Check commit message convention
  • Provide final review feedback

Review Summary

This is a low-risk configuration change that appropriately updates Atlassian Compass metadata. All changes are justified and correctly implemented.

✅ What Was Done Well

1. Link Type Reclassifications (Appropriate)

  • Status Page: OTHER_LINKDASHBOARD

    • Rationale: Displays uptime/reliability KPIs
    • Matches Compass definition: "dashboards for KPIs, observability, or usage"
  • Sentry: OTHER_LINKDASHBOARD

    • Rationale: Error observability dashboard
    • Fits the same Compass category

2. Missing Link Restored

  • Ketryx Project: Added as OTHER_LINK
    • Required by SW-SOP-01 but was missing from main
    • Correctly categorized (not a dashboard, just a project link)

3. Broken URL Fixed

  • Jira Board: Added board ID /1799
    • The generic /boards path returns 404 for classic Jira projects
    • Now correctly points to the specific board

4. Process Compliance

  • References PYSDK-88 Jira ticket ✅
  • Follows CC-SOP-01 Change Control process ✅
  • Links to ISO 13485-certified QMS ✅

5. Changes Match Description
All claimed changes in the PR description are present in the diff (verified via git diff pr-576~2..pr-576).

💡 Minor Suggestion for Future PRs

Commit Message Scope: For stricter conventional commit compliance, consider adding a scope:

- chore: fix link types and add missing Ketryx link in compass.yml PYSDK-88
+ chore(compass): fix link types and add missing Ketryx link in compass.yml PYSDK-88

This is a very minor point and doesn't affect the quality of this PR. The current format (chore:) is acceptable.

Risk Assessment

  • Risk Level: Minimal (configuration-only change)
  • No Code Impact: No Python code, tests, or medical device software affected
  • No Breaking Changes: Purely metadata updates for external systems
  • QMS Compliant: Follows required process (CC-SOP-01, references Ketryx)

Verification Steps (Post-Merge)

The PR test plan should verify:

  • CI green ✅ (SonarQube passed per comments)
  • Compass shows Status Page and Sentry under Dashboards
  • Ketryx Project link appears under Other Links
  • Jira Board link opens correctly at /boards/1799
  • No "compass.yml sync failed" banner in Compass UI

Since this is merged, the team should verify these items in the Compass UI.


Final Verdict: ✅ LGTM (Retrospective)

This PR makes sensible configuration improvements with proper justification. The link type reclassifications align with Atlassian Compass's intended use, the missing Ketryx link was correctly restored, and the Jira URL fix resolves a 404 issue.

No action required - the PR is already merged and the changes are appropriate.


@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.
see 19 files with indirect coverage changes

@helmut-hoffer-von-ankershoffen helmut-hoffer-von-ankershoffen added sop:cc-sop-01 CC-SOP-01 Change Control (feature / planned change) type:chore Tooling, maintenance, routine task (conventional chore) scope:dev-only Affects only our dev/CI env; consumers unaffected labels Apr 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope:dev-only Affects only our dev/CI env; consumers unaffected skip:test:long_running Skip long-running tests (≥5min) sop:cc-sop-01 CC-SOP-01 Change Control (feature / planned change) type:chore Tooling, maintenance, routine task (conventional chore)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants