Skip to content

chore(ci): create scorecard.yml - #113

Merged
aaguiarz merged 1 commit into
mainfrom
aaguiarz-patch-1
Aug 13, 2025
Merged

chore(ci): create scorecard.yml#113
aaguiarz merged 1 commit into
mainfrom
aaguiarz-patch-1

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 an automated workflow to regularly assess supply-chain security using OSSF Scorecard and upload results to the code scanning dashboard.

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

coderabbitai Bot commented Aug 9, 2025

Copy link
Copy Markdown

Walkthrough

A new GitHub Actions workflow file, .github/workflows/scorecard.yml, has been introduced. This workflow automates OSSF Scorecard supply-chain security analysis on the repository, running on specific triggers such as branch protection changes, scheduled intervals, and pushes to the main branch. It manages permissions, executes the analysis, and uploads results.

Changes

Cohort / File(s) Change Summary
GitHub Actions Workflow Addition
.github/workflows/scorecard.yml
Adds a workflow for OSSF Scorecard supply-chain security analysis, including job configuration, triggers, permissions, and result uploads.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 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 aaguiarz-patch-1

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

codecov-commenter commented Aug 9, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 31.70%. Comparing base (dcd8755) to head (4784957).
⚠️ Report is 52 commits behind head on main.

❌ Your project status has failed because the head coverage (31.70%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #113   +/-   ##
=======================================
  Coverage   31.70%   31.70%           
=======================================
  Files         135      135           
  Lines        6848     6848           
  Branches      900      900           
=======================================
  Hits         2171     2171           
  Misses       4489     4489           
  Partials      188      188           

☔ 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.

@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: 4

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

17-20: Add concurrency to prevent overlapping scheduled runs

Avoid duplicate code scanning uploads when schedules overlap or re-runs happen.

 # Declare default permissions as read only.
 permissions: read-all
+
+concurrency:
+  group: scorecard-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true

41-60: Enable the Branch-Protection check (optional) by providing a PAT

Without repo_token, the Branch-Protection check is typically skipped on public repos. If you want that signal, add a fine-grained PAT secret.

           # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional.
-          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+          repo_token: ${{ secrets.SCORECARD_TOKEN }}

Action required: create SCORECARD_TOKEN as a fine-grained PAT with the scopes recommended in the Scorecard docs. Verify it works and does not grant excess permissions.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dcd8755 and 4784957.

📒 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). (1)
  • GitHub Check: Analyze (csharp)
🔇 Additional comments (1)
.github/workflows/scorecard.yml (1)

35-78: Good supply-chain hygiene: actions pinned to SHAs

Strong work pinning third-party actions to commit SHAs and reducing default permissions. This meaningfully lowers supply-chain risk.

Comment thread .github/workflows/scorecard.yml
Comment thread .github/workflows/scorecard.yml
Comment thread .github/workflows/scorecard.yml
Comment thread .github/workflows/scorecard.yml
@aaguiarz
aaguiarz enabled auto-merge August 13, 2025 21:09
@rhamzeh rhamzeh changed the title Create scorecard.yml choreCreate scorecard.yml Aug 13, 2025
@rhamzeh rhamzeh changed the title choreCreate scorecard.yml chore(ci): create scorecard.yml Aug 13, 2025
@aaguiarz
aaguiarz added this pull request to the merge queue Aug 13, 2025
@rhamzeh
rhamzeh removed this pull request from the merge queue due to a manual request Aug 13, 2025
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to Branch Protection failures Aug 13, 2025
You're not authorized to push to this branch. Visit "About protected branches" for more information.
@aaguiarz
aaguiarz added this pull request to the merge queue Aug 13, 2025
Merged via the queue into main with commit acb8557 Aug 13, 2025
18 checks passed
@aaguiarz
aaguiarz deleted the aaguiarz-patch-1 branch August 13, 2025 21:36
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.

4 participants