build: harden the repo

[ramirezj]

No description provided.

[coderabbitai]

Walkthrough

The repository has embraced a comprehensive update across various configurations and workflows to enhance security, dependency management, and code quality. These changes introduce automated checks for code vulnerabilities, dependency reviews, pull request reviews, and security scoring, alongside minor adjustments for formatting and pre-commit configurations. This holistic approach ensures a robust, secure, and efficiently managed codebase.

Changes

Files	Change Summary
.github/workflows/codeql.yml	Sets up CodeQL workflow for security analysis.
.github/workflows/dependency-review.yml	Introduces "Dependency Review" to scan for vulnerable packages in PRs.
.github/workflows/pr-review.yml	Automates project preparation and security on PRs.
.github/workflows/scorecard.yml	Adds "Scorecard OSSF" workflow for security analysis and scoring.
.gitignore, .npmrc, .storybook/main.ts, .storybook/preview-head.html, LICENSE	Formatting adjustments.
.pre-commit-config.yaml	Adds hooks for gitleaks, end-of-file-fixer, and trailing-whitespace.
package.json	Updates required Node.js and pnpm versions.
renovate.json	Adds extensions for GitHub Action digests, git sign-off, and enables pre-commit.

Possibly related issues

• Dependency Dashboard cloud-factory#9: The updates to dependency management and pre-commit configurations could directly impact the objectives related to keeping dependencies up to date and ensuring configurations are maintained, making it relevant to link to this PR.

🐰✨

In the code's garden, under the moon's soft gaze,
We toil and tweak, through the digital maze.
With each push and pull, our garden grows,
Secured and nurtured, by workflows it knows.
Let's hop with joy, for the changes we've made,
In bytes and bits, our efforts displayed.
🌟🌿🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[ramirezj]

@coderabbitai review

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 68841d7 and 150d36b.

Files ignored due to path filters (8)

• stories/assets/code-brackets.svg is excluded by !**/*.svg
• stories/assets/colors.svg is excluded by !**/*.svg
• stories/assets/comments.svg is excluded by !**/*.svg
• stories/assets/direction.svg is excluded by !**/*.svg
• stories/assets/flow.svg is excluded by !**/*.svg
• stories/assets/plugin.svg is excluded by !**/*.svg
• stories/assets/repo.svg is excluded by !**/*.svg
• stories/assets/stackalt.svg is excluded by !**/*.svg

Files selected for processing (12)

• .github/workflows/codeql.yml (1 hunks)
• .github/workflows/dependency-review.yml (1 hunks)
• .github/workflows/pr-review.yml (1 hunks)
• .github/workflows/scorecard.yml (1 hunks)
• .gitignore (1 hunks)
• .npmrc (1 hunks)
• .pre-commit-config.yaml (1 hunks)
• .storybook/main.ts (1 hunks)
• .storybook/preview-head.html (1 hunks)
• LICENSE (1 hunks)
• package.json (1 hunks)
• renovate.json (2 hunks)

Files skipped from review due to trivial changes (3)

• .gitignore
• .npmrc
• LICENSE

Additional comments not posted (9)

.pre-commit-config.yaml (1)

1-10: Ensure the versions of gitleaks and pre-commit-hooks are up-to-date for optimal security and functionality.

renovate.json (1)

3-3: Confirm the compatibility of the new renovate.json settings with the project's workflow.

.github/workflows/dependency-review.yml (1)

1-27: Ensure the versions of harden-runner and dependency-review-action used in this workflow are up-to-date for optimal security and functionality.

.github/workflows/codeql.yml (1)

1-50: Ensure the versions of harden-runner and codeql-action used in this workflow are up-to-date and review the egress-policy and queries settings for optimal security and functionality.

.github/workflows/pr-review.yml (1)

1-55: Ensure the versions of GitHub Actions used in this workflow are up-to-date and review the node-version setting to confirm it aligns with the project's requirements.

package.json (1)

58-59: Confirm the compatibility of the updated Node.js and pnpm version requirements with the project's dependencies and workflow.

.github/workflows/scorecard.yml (3)

1-58: Ensure the use of pinned action versions aligns with the project's security policies.

Using exact commit hashes (uses: action/name@commit-hash) for GitHub Actions, as seen in this workflow, is a good practice for ensuring the security and reliability of the workflow. It prevents potential issues from automatic updates or compromised versions. However, it's important to regularly review and update these dependencies to include the latest features and security patches. Consider setting up a process for periodically checking and updating these pinned versions.

---

20-46: Consider adding error handling for the analysis step.

The "Run Analysis" step uses the ossf/scorecard-action to perform security analysis. While this is set up correctly, consider adding error handling or conditional steps based on the outcome of the analysis. This could involve failing the workflow if critical issues are found or sending notifications to relevant parties. Utilizing the if conditionals or step outputs can enhance the workflow's robustness and responsiveness to security findings.

---

48-53: Review the artifact retention policy.

The "Upload Artifact" step specifies a retention period of 5 days for the SARIF file. While this might be suitable for the project's current needs, consider evaluating whether this duration aligns with your project's audit and review processes. Depending on the frequency of analysis and the team's capacity to review findings, a longer or shorter retention period might be more appropriate.