Skip to content

chore(scorecard): align examples to see all at once#3528

Open
christoph-jerolimov wants to merge 1 commit into
redhat-developer:mainfrom
christoph-jerolimov:scorecard/align-examples
Open

chore(scorecard): align examples to see all at once#3528
christoph-jerolimov wants to merge 1 commit into
redhat-developer:mainfrom
christoph-jerolimov:scorecard/align-examples

Conversation

@christoph-jerolimov

Copy link
Copy Markdown
Member

Hey, I just made a Pull Request!

yarn start before:

image

With this change:

image

✔️ 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)

Signed-off-by: Christoph Jerolimov <jerolimov+git@redhat.com>
@sonarqubecloud

Copy link
Copy Markdown

@fullsend-ai-review

fullsend-ai-review Bot commented Jun 22, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 10:26 AM UTC · Completed 10:35 AM UTC
Commit: a408de5 · View workflow run →

@codecov

codecov Bot commented Jun 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 53.63%. Comparing base (a408de5) to head (ef2c8af).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3528   +/-   ##
=======================================
  Coverage   53.63%   53.63%           
=======================================
  Files        2260     2260           
  Lines       85972    85972           
  Branches    24185    24185           
=======================================
  Hits        46112    46112           
  Misses      38369    38369           
  Partials     1491     1491           
Flag Coverage Δ *Carryforward flag
adoption-insights 83.70% <ø> (ø) Carriedforward from a408de5
ai-integrations 67.95% <ø> (ø) Carriedforward from a408de5
app-defaults 69.79% <ø> (ø) Carriedforward from a408de5
augment 46.39% <ø> (ø) Carriedforward from a408de5
boost 74.64% <ø> (ø) Carriedforward from a408de5
bulk-import 72.46% <ø> (ø) Carriedforward from a408de5
cost-management 14.10% <ø> (ø) Carriedforward from a408de5
dcm 61.79% <ø> (ø) Carriedforward from a408de5
extensions 61.53% <ø> (ø) Carriedforward from a408de5
global-floating-action-button 71.18% <ø> (ø) Carriedforward from a408de5
global-header 59.71% <ø> (ø) Carriedforward from a408de5
homepage 49.84% <ø> (ø) Carriedforward from a408de5
install-dynamic-plugins 56.23% <ø> (ø) Carriedforward from a408de5
konflux 91.49% <ø> (ø) Carriedforward from a408de5
lightspeed 68.57% <ø> (ø) Carriedforward from a408de5
mcp-integrations 85.46% <ø> (ø) Carriedforward from a408de5
orchestrator 37.75% <ø> (ø) Carriedforward from a408de5
quickstart 63.76% <ø> (ø) Carriedforward from a408de5
sandbox 79.56% <ø> (ø) Carriedforward from a408de5
scorecard 83.96% <ø> (ø)
theme 61.26% <ø> (ø) Carriedforward from a408de5
translations 7.25% <ø> (ø) Carriedforward from a408de5
x2a 78.68% <ø> (ø) Carriedforward from a408de5

*This pull request uses carry forward flags. Click here to find out more.


Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a408de5...ef2c8af. Read the comment docs.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@fullsend-ai-review

Copy link
Copy Markdown

Looks good to me

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label Jun 22, 2026
@rhdh-qodo-merge

Copy link
Copy Markdown

Code Review by Qodo

Grey Divider

Sorry, something went wrong

We weren't able to complete the code review on our side. Please try again

Grey Divider

Qodo Logo

@rhdh-qodo-merge

Copy link
Copy Markdown

PR Summary by Qodo

scorecard: align example catalog location + component names for one-screen view
📝 Documentation ⚙️ Configuration changes 🕐 10-20 Minutes

Grey Divider

Description

• Point scorecard workspace configs at the consolidated example location file.
• Expand the example Location to include all scorecard/no-scorecard component variants.
• Normalize example Component entity names and split the “different owner” variant into its own
 file.
Diagram

graph TD
  A["Scorecard workspace configs"] --> B["Backstage catalog"] --> C["all-scorecard-locations.yaml"] --> D["Component example YAMLs"]
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Keep a compatibility alias for the old location filename
  • ➕ Avoids breaking any external docs/scripts that still reference all-scorecards-location.yaml
  • ➕ Provides a smoother transition for users copying older examples
  • ➖ Duplicates example content or adds an extra file to maintain
  • ➖ May confuse readers about which file is canonical

Recommendation: The PR’s approach (rename + update all in-repo references, plus clearer component naming) is appropriate for example content. If these examples are referenced outside the repo, consider keeping a short-lived alias copy (or stub Location) under the old filename to reduce churn; otherwise, the current cleanup is the simplest and clearest.

Files changed (11) +25 / -38

Documentation (9) +23 / -36
all-scorecard-locations.yamlRename Location entity and reorder/expand example targets +4/-3

Rename Location entity and reorder/expand example targets

• Renames the Location entity to match the filename and reorders targets so the full set of examples is loaded together. Adds explicit targets for the new “different owner” component and the no-scorecards component in the intended viewing order.

workspaces/scorecard/examples/all-scorecard-locations.yaml

all-scorecards-service-different-owner.yamlAdd separate component example for different owner/label variant +14/-0

Add separate component example for different owner/label variant

• Introduces a dedicated Component entity that includes both GitHub and Jira annotations plus a distinct owner/label combination. This was previously embedded in the all-scorecards.yaml example and is now split for clarity.

workspaces/scorecard/examples/components/all-scorecards-service-different-owner.yaml

all-scorecards.yamlNormalize primary 'all scorecards' component example +2/-19

Normalize primary 'all scorecards' component example

• Renames the example component to a shorter canonical name and updates the owner to a consistent group reference. Removes the embedded second YAML document now split into its own file.

workspaces/scorecard/examples/components/all-scorecards.yaml

dependabot-scorecard-only.yamlClean up example header noise +0/-2

Clean up example header noise

• Removes YAML document separators and inline comment header to keep the example file compact and consistent with other examples.

workspaces/scorecard/examples/components/dependabot-scorecard-only.yaml

github-scorecard-only.yamlRename GitHub-only component example to canonical name +1/-3

Rename GitHub-only component example to canonical name

• Updates the component metadata.name to a shorter, consistent identifier (dropping the '-service' suffix). This improves scanability when listing entities together.

workspaces/scorecard/examples/components/github-scorecard-only.yaml

jira-scorecard-only.yamlRename Jira-only component example to canonical name +1/-3

Rename Jira-only component example to canonical name

• Updates the component metadata.name to a shorter, consistent identifier (dropping the '-service' suffix). Keeps naming aligned across all example entities.

workspaces/scorecard/examples/components/jira-scorecard-only.yaml

no-scorecards.yamlRename 'no scorecards' component example to canonical name +1/-3

Rename 'no scorecards' component example to canonical name

• Updates the component metadata.name to a shorter, consistent identifier (dropping the '-service' suffix). Helps the no-scorecard case appear alongside the other examples cleanly.

workspaces/scorecard/examples/components/no-scorecards.yaml

openssf-scorecard-only.yamlClean up YAML document separator +0/-1

Clean up YAML document separator

• Removes the leading YAML document separator to match the simplified formatting used across the example entities.

workspaces/scorecard/examples/components/openssf-scorecard-only.yaml

sonarqube-scorecard-only.yamlClean up example header noise +0/-2

Clean up example header noise

• Removes YAML document separators and inline comment header to keep the example file concise and consistent.

workspaces/scorecard/examples/components/sonarqube-scorecard-only.yaml

Other (2) +2 / -2
app-config.local.EXAMPLE.yamlUpdate example catalog location reference +1/-1

Update example catalog location reference

• Updates the example scorecard workspace config to reference the renamed consolidated Location file (all-scorecard-locations.yaml). This keeps the local example aligned with the curated set of example entities.

workspaces/scorecard/app-config.local.EXAMPLE.yaml

app-config.yamlPoint catalog.locations at consolidated scorecard example Location +1/-1

Point catalog.locations at consolidated scorecard example Location

• Adjusts the workspace catalog configuration to target the renamed all-scorecard-locations.yaml. Ensures the default config loads the full curated example set.

workspaces/scorecard/app-config.yaml

@rhdh-qodo-merge rhdh-qodo-merge Bot added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 22, 2026

@Eswaraiahsapram Eswaraiahsapram left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good to me

spec:
type: service
owner: rhdh-team
owner: group:development/guests

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we wanted to leave at least one scorecard to have owner as a user instead of group to cover that use case. It doesn't necessarily have to be all-scorecards.yaml. Is there any other scorecard covering it?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Nope. But that was the problem why the catalog switches to show just this catalog.

But I can investigate why it doesn't show everything because the guest user is in both groups.

Thanks for the feedback, will take a look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request ready-for-merge All reviewers approved — ready to merge workspace/scorecard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants