Skip to content

feat: add CI linting and formatting checks to prevent bypass via GitHub UI#2061

Merged
jcstein merged 4 commits intomainfrom
copilot/fix-1399
Jun 3, 2025
Merged

feat: add CI linting and formatting checks to prevent bypass via GitHub UI#2061
jcstein merged 4 commits intomainfrom
copilot/fix-1399

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jun 3, 2025

This PR adds comprehensive linting and formatting checks to the GitHub Actions build workflow to ensure code quality standards are enforced for all pull requests, regardless of how they are created.

Problem

Previously, linting and formatting checks were only enforced locally through Husky pre-commit hooks. This meant that:

  • PRs created via GitHub UI bypassed all linting/formatting checks
  • Contributors who didn't install dependencies locally could commit without checks
  • This led to inconsistent code quality and formatting issues being merged

Solution

Added the following CI checks to .github/workflows/build.yml:

  1. JavaScript/TypeScript Linting (yarn eslint) - Fails on linting issues
  2. Code Formatting Check (yarn prettier --check) - Fails if files aren't properly formatted
  3. Markdown Linting (yarn lint:md) - Shows issues with continue-on-error: true to handle existing issues

All checks run before the build step, ensuring code quality is verified before deployment.

Key Features

  • Immediate enforcement for JS/TS linting and formatting
  • Backward compatibility - existing build process unchanged
  • Graceful handling of pre-existing markdown issues via continue-on-error
  • Minimal changes - only 7 lines added to workflow file

Testing

Verified that:

  • All checks pass with current codebase
  • Linting properly fails when issues are introduced
  • Formatting check fails when code is improperly formatted
  • Build continues to work correctly
  • Markdown linting provides visibility without blocking PRs

This ensures that all future PRs will maintain consistent code quality and formatting standards, preventing the issues described in the original report.

Fixes #1399.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits June 3, 2025 09:22
Co-authored-by: jcstein <46639943+jcstein@users.noreply.github.com>
Co-authored-by: jcstein <46639943+jcstein@users.noreply.github.com>
Copilot AI changed the title [WIP] feat: ensure formatting and linting checks done on local development are required for PRs to pass feat: add CI linting and formatting checks to prevent bypass via GitHub UI Jun 3, 2025
Copilot AI requested a review from jcstein June 3, 2025 09:28
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jun 3, 2025

Important

Review skipped

Bot user detected.

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.


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

Support

Need help? Join our Discord community for assistance with any issues or questions.

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 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 sequence diagram to generate a sequence diagram of the changes in 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.

@jcstein jcstein marked this pull request as ready for review June 3, 2025 11:03
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jun 3, 2025

PR Preview Action v1.6.1
Preview removed because the pull request was closed.
2025-06-03 11:05 UTC

@jcstein jcstein merged commit 83ea7d7 into main Jun 3, 2025
7 checks passed
@jcstein jcstein deleted the copilot/fix-1399 branch June 3, 2025 11:05
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.

feat: ensure formatting and linting checks done on local development are required for PRs to pass

2 participants