☕ separate check:doc task

[Milly]

deno test --doc vs deno test --watch is conflicts.
Now can deno task test --watch.

Summary by CodeRabbit

• New Features

  • Introduced a new documentation check task, allowing users to validate documentation separately from running tests.

• Improvements

  • Enhanced CI/CD workflow with a dedicated step for documentation validation to ensure quality before generation.

[coderabbitai]

Walkthrough

This update enhances a Deno project's CI/CD workflow by introducing a "Doc check" step to validate documentation alongside existing code checks. Additionally, it refines task definitions in the deno.jsonc file to separate documentation checks from testing, promoting a clearer workflow. These changes collectively improve the quality assurance process, ensuring that both code and documentation meet specified standards before deployment.

Changes

Files	Change Summary
.github/workflows/test.yml	Added a "Doc check" step to the workflow that runs deno task check:doc, positioned between type checking and generation checks.
deno.jsonc	Modified the test task by removing the --doc flag and added a new check:doc task for documentation checks, enabling independent documentation validation.

Poem

In the land of code where rabbits hop,
We check our docs and never stop!
With tasks aligned and clarity found,
Our documentation's tightly bound.
So raise a cheer for changes bright,
Quality's ensured, all feels just right! 🐇✨

---

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.
  • @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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b2e9943 and 3930629.

Files selected for processing (2)

• .github/workflows/test.yml (1 hunks)
• deno.jsonc (1 hunks)

Additional comments not posted (2)

.github/workflows/test.yml (1)

55-56: Addition of "Doc check" step is appropriate.

The new "Doc check" step enhances the CI/CD workflow by ensuring documentation quality. Its placement between "Type check" and "Gen check" is logical and maintains a clear workflow.

deno.jsonc (1)

84-85: Task separation enhances clarity and usability.

The introduction of the check:doc task and the modification of the test task improve the separation of concerns, allowing documentation checks to be run independently from tests.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.61%. Comparing base (b2e9943) to head (3930629).
Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #259   +/-   ##
=======================================
  Coverage   82.61%   82.61%           
=======================================
  Files          57       57           
  Lines        2979     2979           
  Branches      251      251           
=======================================
  Hits         2461     2461           
  Misses        516      516           
  Partials        2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.