Skip to content

Docs openssf bestpractices badge#4974

Open
sarhiri wants to merge 2 commits into
armadaproject:masterfrom
sarhiri:docs-openssf-bestpractices-badge
Open

Docs openssf bestpractices badge#4974
sarhiri wants to merge 2 commits into
armadaproject:masterfrom
sarhiri:docs-openssf-bestpractices-badge

Conversation

@sarhiri

@sarhiri sarhiri commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • Documentation

What this PR does / why we need it

  • Adds the OpenSSF Best Practices badge to the README and fixes the CircleCI badge, which pointed at the helm/helm repo instead of armadaproject/armada (a copy-paste leftover, so it was showing Helm's build status). The OpenSSF badge addition closes the openssf_badge check on CLOMonitor, part of ongoing work to improve Armada's CLOMonitor score ahead of CNCF Incubation.

Which issue(s) this PR fixes

Fixes # N/A

Special notes for your reviewer

sarhiri added 2 commits June 23, 2026 13:58
Signed-off-by: sarhiri <143043927+sarhiri@users.noreply.github.com>
Signed-off-by: sarhiri <143043927+sarhiri@users.noreply.github.com>
@greptile-apps

greptile-apps Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR makes two targeted badge fixes to README.md: it corrects a copy-paste bug where the CircleCI badge image URL referenced helm/helm instead of armadaproject/armada, and it adds an OpenSSF Best Practices badge to satisfy the openssf_badge check on CLOMonitor as part of CNCF Incubation preparation.

  • CircleCI badge fix: The <img src> URL now points at circleci.com/gh/armadaproject/armada.svg rather than circleci.com/gh/helm/helm.svg, so the badge will correctly show Armada's own build status.
  • OpenSSF badge addition: A new <p> block adds the bestpractices.dev/projects/11485 badge and links it to the corresponding project page.

Confidence Score: 5/5

Documentation-only change with no code or configuration impact; safe to merge.

Both badge URLs are correct and link to the right project pages. The CircleCI fix resolves a long-standing copy-paste error that was silently displaying Helm's build status, and the new OpenSSF badge points to project 11485 which matches the linked href.

No files require special attention.

Important Files Changed

Filename Overview
README.md Fixes CircleCI badge URL (was pointing to helm/helm instead of armadaproject/armada) and adds an OpenSSF Best Practices badge for project 11485.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    README["README.md badges"]
    README --> CI["CircleCI badge\ncircleci.com/gh/armadaproject/armada\n✅ Fixed (was helm/helm)"]
    README --> GR["Go Report Card\ngoreportcard.com/report/github.com/armadaproject/armada"]
    README --> AH["Artifact Hub\nartifacthub.io/packages/helm/gresearch/armada"]
    README --> LFX["LFX Health Score\ninsights.linuxfoundation.org/project/armada"]
    README --> OSSF["OpenSSF Best Practices\nbestpractices.dev/projects/11485\n✅ Newly added"]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    README["README.md badges"]
    README --> CI["CircleCI badge\ncircleci.com/gh/armadaproject/armada\n✅ Fixed (was helm/helm)"]
    README --> GR["Go Report Card\ngoreportcard.com/report/github.com/armadaproject/armada"]
    README --> AH["Artifact Hub\nartifacthub.io/packages/helm/gresearch/armada"]
    README --> LFX["LFX Health Score\ninsights.linuxfoundation.org/project/armada"]
    README --> OSSF["OpenSSF Best Practices\nbestpractices.dev/projects/11485\n✅ Newly added"]
Loading

Reviews (1): Last reviewed commit: "docs: add OpenSSF badge" | Re-trigger Greptile

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant