feat(ci): add build workflow badge and improve workflow documentation

[Copilot]

Overview

This PR adds a build workflow status badge to the README and enhances the existing build workflow with better documentation, matching the implementation from rollkit/docs#469.

Problem

The repository already had a functional build workflow that catches build errors in CI, but it lacked visibility through a status badge. The existing workflow was working correctly but could benefit from clearer documentation about package manager alternatives.

Changes

1. Added Build Status Badge: Added a build workflow badge to README.md to provide clear visibility of the build status
2. Enhanced Workflow Documentation: Updated .github/workflows/build.yml with helpful comments showing package manager alternatives (yarn/pnpm/npm)

How It Works

The build workflow runs on:

• Every push to main branch
• Every pull request

It will fail with a non-zero exit code if:

• Dependencies can't be installed (yarn install)
• VitePress build fails (yarn build) due to syntax errors, missing files, configuration issues, etc.

This provides reliable CI protection against build errors, ensuring that broken builds cannot be merged to main and that contributors get immediate feedback on build issues in their PRs.

Testing

• ✅ Verified the build workflow runs successfully locally
• ✅ Confirmed the workflow triggers on the correct events (push to main, pull requests)
• ✅ Tested that yarn install and yarn build complete successfully
• ✅ Validated that the badge URL points to the correct workflow

Fixes #1739.

---

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

[mergify]

⚠️ The sha of the head commit of this PR conflicts with #2064. Mergify cannot evaluate rules on this PR. ⚠️

[jcstein]

resolve conflicts @copilot

[jcstein]

resume pls @copilot

[Copilot]

resume pls @copilot

I'll resolve the merge conflicts now and get this ready to merge.

[coderabbitai]

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.

[github-actions]

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