Skip to content

chore: create scorecard.yml#245

Merged
rhamzeh merged 1 commit into
mainfrom
feat/add-scorecard
Aug 12, 2025
Merged

chore: create scorecard.yml#245
rhamzeh merged 1 commit into
mainfrom
feat/add-scorecard

Conversation

@aaguiarz

@aaguiarz aaguiarz commented Aug 9, 2025

Copy link
Copy Markdown
Member

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 a new workflow to automatically run supply-chain security checks using OpenSSF Scorecard and upload results to GitHub's code scanning dashboard.

@aaguiarz
aaguiarz requested a review from a team as a code owner August 9, 2025 20:04
@coderabbitai

coderabbitai Bot commented Aug 9, 2025

Copy link
Copy Markdown

Walkthrough

A new GitHub Actions workflow file, .github/workflows/scorecard.yml, has been added. This workflow automates running the OpenSSF Scorecard supply-chain security analysis on the repository, triggers on specific events, and uploads results to GitHub's code scanning dashboard and as an artifact.

Changes

Cohort / File(s) Change Summary
New Scorecard Security Workflow
.github/workflows/scorecard.yml
Introduces a GitHub Actions workflow to run OpenSSF Scorecard analysis, trigger on key events, and upload SARIF results to GitHub code scanning and as an artifact.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/add-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.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.16%. Comparing base (2fc7d56) to head (a31ccc1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #245   +/-   ##
=======================================
  Coverage   88.16%   88.16%           
=======================================
  Files          23       23           
  Lines        1217     1217           
  Branches      216      197   -19     
=======================================
  Hits         1073     1073           
  Misses         86       86           
  Partials       58       58           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Nitpick comments (2)
.github/workflows/scorecard.yml (2)

21-24: Avoid stuck or overlapping runs

Add a conservative timeout and concurrency to reduce runner waste and overlapping schedule runs.

   analysis:
     name: Scorecard analysis
     runs-on: ubuntu-latest
+    timeout-minutes: 20
+    concurrency:
+      group: scorecard-${{ github.ref || github.run_id }}
+      cancel-in-progress: false

42-60: Branch-Protection check and publishing nuances

  • Branch-Protection check on public repos requires a fine-grained PAT via repo_token; otherwise that check is skipped. If you want that signal, wire a SCORECARD_TOKEN secret as documented.
  • publish_results: true is correctly set; it will only publish from default branch. Ensure you’re comfortable with public publication and consider adding the badge to README once results appear.

I can add the README badge and the repo_token wiring if desired.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2fc7d56 and a31ccc1.

📒 Files selected for processing (1)
  • .github/workflows/scorecard.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/scorecard.yml (1)

17-19: Secure-by-default permissions look good

Least-privilege baseline with read-all and job-scoped security-events/id-token writes is appropriate for Scorecard publishing and code scanning.

Also applies to: 26-34

Comment thread .github/workflows/scorecard.yml
Comment thread .github/workflows/scorecard.yml
Comment thread .github/workflows/scorecard.yml
@rhamzeh rhamzeh changed the title Create scorecard.yml chore: create scorecard.yml Aug 12, 2025
@rhamzeh
rhamzeh enabled auto-merge August 12, 2025 13:05
@rhamzeh
rhamzeh added this pull request to the merge queue Aug 12, 2025
Merged via the queue into main with commit 2d57837 Aug 12, 2025
21 checks passed
@rhamzeh
rhamzeh deleted the feat/add-scorecard branch August 12, 2025 13:06
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.

3 participants