Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: parallelize codecheck #9983

Merged
merged 3 commits into from
Jul 16, 2024
Merged

chore: parallelize codecheck #9983

merged 3 commits into from
Jul 16, 2024

Conversation

mattkrick
Copy link
Member

@mattkrick mattkrick commented Jul 16, 2024

codecheck currently takes 2 mins!
The bulk of that is prettier.
We could replace prettier + eslint with biome. It runs in 2 seconds!
Unfortunately, we require prettier-plugin-tailwindcss on the frontend.
Until biome offers support for tailwind class sorting (biomejs/biome#1274) we can't switch.

As an alternative, we can run prettier & eslint in parallel to the testing suite

Summary by CodeRabbit

  • Chores
    • Introduced a GitHub Actions workflow for style checks to ensure code quality on push events.
    • Renamed "Check Code Quality" step to "Typecheck" in the test workflow to focus on type checking.
    • Updated the codecheck script in package.json to remove typecheck, simplifying the script.

Copy link
Contributor

coderabbitai bot commented Jul 16, 2024

Warning

Rate limit exceeded

@mattkrick has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 43 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 0870911 and 2c61cd9.

Walkthrough

The updates streamline code quality and type checking processes in GitHub Actions workflows. A new "Style Check" workflow is added, focusing on code quality checks like linting and styling. Meanwhile, the existing "test.yml" workflow is adjusted to focus solely on type checking. Additionally, the package.json script is simplified by removing type checking from the codecheck command, keeping only lint and style checks.

Changes

Files Change Summary
.github/workflows/style-check.yml Introduces a workflow named "Style Check" for code quality checks, triggered on push events, and excludes specific branches.
.github/workflows/test.yml Renames "Check Code Quality" step to "Typecheck" and updates the command to yarn typecheck.
package.json Updates codecheck script by removing typecheck, leaving only lintcheck and stylecheck.

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
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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

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.

Signed-off-by: Matt Krick <[email protected]>
@mattkrick mattkrick merged commit cec7063 into master Jul 16, 2024
6 checks passed
@mattkrick mattkrick deleted the chore/move-style-check branch July 16, 2024 19:17
@github-actions github-actions bot mentioned this pull request Jul 17, 2024
24 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant