Skip to content

Add actionlint to pre-commit config #468

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Feb 26, 2025
Merged

Add actionlint to pre-commit config #468

merged 1 commit into from
Feb 26, 2025

Conversation

lucacome
Copy link
Owner

@lucacome lucacome commented Feb 26, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Chores
    • Enhanced the automated quality checks by introducing a new YAML validation process and using clearer step descriptions.
    • Updated key linting tool versions and added an additional linting tool to improve overall code consistency and maintenance efficiency.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 26, 2025 •
edited
Loading

Warning

Rate limit exceeded

@lucacome has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 35 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 3e85fb2 and 033ae74.

📒 Files selected for processing (2)
  • .github/workflows/lint.yml (2 hunks)
  • .pre-commit-config.yaml (2 hunks)

Walkthrough

The pull request updates the lint workflow and pre-commit configuration. In the workflow file, descriptive step names have been added for Actionlint and Markdown linting, and a new job (yaml-lint) has been introduced to lint YAML files using reviewdog. In the pre-commit configuration file, the version of markdownlint-cli2 has been upgraded and a new repository for actionlint has been added with a specific version. These changes enhance clarity and consistency in linting processes without altering core functionality.

Changes

File Summary
.github/workflows/lint.yml Renamed lint steps ("Lint Actions" and "Lint Markdown"), modified the markdown glob quotes, and added a new yaml-lint job.
.pre-commit-config.yaml Upgraded markdownlint-cli2 from v0.14.0 to v0.17.2 and added a new repository for actionlint (v1.7.7).

Sequence Diagram(s)

sequenceDiagram
    participant R as CI Runner
    participant W as Lint Workflow
    participant A as "Lint Actions"
    participant M as "Lint Markdown"
    participant Y as "YAML Lint"
    R->>W: Trigger workflow
    W->>A: Run Actionlint step ("Lint Actions")
    W->>M: Run Markdown lint step ("Lint Markdown")
    W->>Y: Run YAML lint job
Loading

Possibly related PRs

Suggested labels

dependencies, chore

Poem

I hopped through the code under moonlit skies,
Renaming steps and adding new replies.
YAML now gets a careful check,
As linting flows without a speck.
A rabbit’s joy in every commit—hurray! 🐰

(Binky and hops, our code now never stops!)

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>, 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.
  • @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 github-actions bot added the chore label Feb 26, 2025
@lucacome
Copy link
Owner Author

@coderabbitai full review

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 26, 2025

✅ Actions performed

Full review triggered.

@lucacome lucacome merged commit a4fba0e into main Feb 26, 2025
15 checks passed
@lucacome lucacome deleted the chore/actionlint branch February 26, 2025 04:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
chore
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@lucacome