Create scorecard.yml #548

aaguiarz · 2025-08-02T21:13:10Z

Adding scorecard for CLI. There's a prebuilt Action for this in the Security → Code scanning tab.

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

References

Review Checklist

I have clicked on "allow edits by maintainers".
I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
The correct base branch is being used, if not main
I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

Chores
- Introduced an automated security analysis workflow using OSSF Scorecard, running on main branch updates and weekly schedules.
- Security scan results are uploaded to GitHub's code scanning dashboard and retained as artifacts for 5 days.

Adding scorecard for CLI

coderabbitai · 2025-08-02T21:13:24Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new GitHub Actions workflow file, .github/workflows/scorecard.yml, has been added. This workflow sets up automated supply-chain security analysis using the OSSF Scorecard tool, triggered by branch protection rule changes, weekly schedules, and pushes to the main branch. It includes steps for running the analysis and uploading results.

Changes

Cohort / File(s)	Change Summary
Add Scorecard Security Workflow `.github/workflows/scorecard.yml`	Introduces a GitHub Actions workflow for OSSF Scorecard supply-chain security analysis with scheduled and event-based triggers, minimal permissions, and SARIF result uploads.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch chore/scorecard

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (1)

.github/workflows/scorecard.yml (1)
20-24: Add a concurrency group to avoid overlapping runs

Multiple pushes in quick succession (e.g., force-pushes) will enqueue many identical Scorecard jobs.
A simple concurrency block keeps only the latest run active and frees CI minutes.
   analysis:
     name: Scorecard analysis
     runs-on: ubuntu-latest
+    concurrency:
+      group: scorecard-${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d9df07f and 423b520.

📒 Files selected for processing (1)

.github/workflows/scorecard.yml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

GitHub Check: Test Release Process
GitHub Check: Tests
GitHub Check: Analyze (go)

🔇 Additional comments (1)

.github/workflows/scorecard.yml (1)

24-26: if: expression may mis-detect default-branch runs

github.event.repository.default_branch == github.ref_name works for push but not for
branch_protection_rule (where github.ref_name is empty) and can be noisy when the default
branch is renamed. A more robust guard is to compare against the full ref:
-    if: github.event.repository.default_branch == github.ref_name || github.event_name == 'pull_request'
+    if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch) || github.event_name == 'pull_request'

.github/workflows/scorecard.yml

Added commit hash for codeql action

Create scorecard.yml

423b520

Adding scorecard for CLI

aaguiarz requested a review from a team as a code owner August 2, 2025 21:13

coderabbitai bot reviewed Aug 2, 2025

View reviewed changes

.github/workflows/scorecard.yml Show resolved Hide resolved

.github/workflows/scorecard.yml Outdated Show resolved Hide resolved

Update scorecard.yml

bc59d55

Added commit hash for codeql action

rhamzeh approved these changes Aug 7, 2025

View reviewed changes

Merge branch 'main' into chore/scorecard

4edfa30

aaguiarz enabled auto-merge August 7, 2025 13:26

aaguiarz added this pull request to the merge queue Aug 7, 2025

Merged via the queue into main with commit 956cdd6 Aug 7, 2025
22 checks passed

aaguiarz deleted the chore/scorecard branch August 7, 2025 13:30

coderabbitai bot mentioned this pull request Aug 22, 2025

chore(readme): Update Twitter badge to X and add OpenSSF Scorecard #567

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Create scorecard.yml #548

Create scorecard.yml #548

Uh oh!

aaguiarz commented Aug 2, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 2, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Create scorecard.yml #548

Create scorecard.yml #548

Uh oh!

Conversation

aaguiarz commented Aug 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

References

Review Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aaguiarz commented Aug 2, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)