ci: add constraints on jobs to start based on linters

[glihm]

Summary by CodeRabbit

• Chores
  • Updated CI workflow configuration to improve job dependency management
  • Ensured specific jobs now run only after formatting checks are completed

[coderabbitai]

Walkthrough

Ohayo, sensei! The CI workflow in .github/workflows/ci.yml has been enhanced with job dependencies. The build, ensure-wasm, clippy, and docs jobs now require the successful completion of the fmt and cairofmt formatting jobs before they can execute. This change ensures a structured workflow where code formatting validation occurs before subsequent build, testing, and documentation generation steps.

Changes

File	Changes
.github/workflows/ci.yml	- Added needs: [fmt, cairofmt] to build job - Added needs: [fmt, cairofmt] to ensure-wasm job - Added needs: [fmt, cairofmt] to clippy job - Added needs: [fmt, cairofmt] to docs job

Sequence Diagram

sequenceDiagram
    participant fmt as Formatting (fmt)
    participant cairofmt as Cairo Formatting (cairofmt)
    participant build as Build Job
    participant wasm as Ensure WASM Job
    participant clippy as Clippy Job
    participant docs as Docs Job

    fmt->>build: Trigger after completion
    cairofmt->>build: Trigger after completion
    fmt->>wasm: Trigger after completion
    cairofmt->>wasm: Trigger after completion
    fmt->>clippy: Trigger after completion
    cairofmt->>clippy: Trigger after completion
    fmt->>docs: Trigger after completion
    cairofmt->>docs: Trigger after completion

Loading

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3daa543 and 19c6247.

📒 Files selected for processing (1)

• .github/workflows/ci.yml (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: fmt

🔇 Additional comments (4)

.github/workflows/ci.yml (4)

16-16: Ohayo sensei! Ensuring the build job depends on formatting checks is a wise move.

This establishes a vital quality gate, guaranteeing that code cannot be built if it neglects formatting standards.

---

59-59: Ohayo sensei! Great job adding the needs dependency to the ensure-wasm job.

This shields the downstream environment from unformatted code in WASM builds, preserving adherence to the style guidelines before shipping.

---

158-158: Ohayo sensei! The clippy job now gating on fmt and cairofmt is superb.

This maintains robust code cleanliness and reduces friction for style or linter arguments.

---

177-177: Ohayo sensei! The docs job also waiting for formatting checks is a neat addition.

Delaying documentation generation until after conforming code style ensures a consistent and professional look.

---

🪧 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.
  • 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 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 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 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. (Beta)
• @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.

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.