Skip to content

chore: added codespell#1833

Merged
tusharmath merged 3 commits intotailcallhq:mainfrom
ezhil56x:spell
May 2, 2024
Merged

chore: added codespell#1833
tusharmath merged 3 commits intotailcallhq:mainfrom
ezhil56x:spell

Conversation

@ezhil56x
Copy link
Copy Markdown
Contributor

@ezhil56x ezhil56x commented May 1, 2024 •
edited
Loading

Added check spelling in spell-check.yml
Closes #805

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 1, 2024 •
edited
Loading

Walkthrough

Walkthrough

The recent changes include the addition of a GitHub Actions workflow named "Build docs" in the ci-docs.yml file to trigger spell checking on changes in the docs/ directory and Markdown files. Another workflow in spell-check.yml focuses on spell checking documentation and Markdown files using the codespell-project/actions-codespell action.

Changes

File Path Change Summary
.github/workflows/ci-docs.yml Introduced a GitHub Actions workflow "Build docs" for spell checking
.github/workflows/spell-check.yml Added a workflow for spell checking using codespell-project/actions-codespell

Assessment against linked issues

Objective Addressed Explanation
Add a spell check in lint and CI (#805) ✅
Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 0c60a9f and 8390ac7.
Files selected for processing (1)
  • .github/workflows/spell-check.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/spell-check.yml

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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 github-actions bot added the type: chore Routine tasks like conversions, reorganization, and maintenance work. label May 1, 2024
@codecov
Copy link
Copy Markdown

codecov bot commented May 1, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.89%. Comparing base (b99849e) to head (8390ac7).

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1833      +/-   ##
==========================================
- Coverage   86.89%   86.89%   -0.01%     
==========================================
  Files         156      156              
  Lines       15829    15829              
==========================================
- Hits        13755    13754       -1     
- Misses       2074     2075       +1

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

tusharmath
tusharmath reviewed May 2, 2024
View reviewed changes
.github/workflows/ci-docs.yml
- "**"
paths:
- "docs/**"
- "**.md"
Copy link
Copy Markdown
Contributor

@tusharmath tusharmath May 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spell check should be performed on .rs files also.

@tusharmath tusharmath merged commit e615b24 into tailcallhq:main May 2, 2024
@tusharmath
Copy link
Copy Markdown
Contributor

tusharmath commented May 2, 2024

thank you @ezhil56x !

ssddOnTop pushed a commit that referenced this pull request May 2, 2024
@ezhil56x @ssddOnTop
chore: added codespell (#1833)
e689fc7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tusharmath tusharmath tusharmath left review comments

Assignees

No one assigned

Labels

type: chore Routine tasks like conversions, reorganization, and maintenance work.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

add a spell check in lint and CI

2 participants

@ezhil56x @tusharmath