Skip to content
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.

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

OSOE-188: YAML Linting #647

Merged
merged 65 commits into from
Jan 26, 2024
Merged

OSOE-188: YAML Linting #647

merged 65 commits into from
Jan 26, 2024

Conversation

tteguayco
Copy link
Contributor

@tteguayco tteguayco commented Dec 16, 2023

Enabling linting of YAML files from:

  • GitHub Actions
  • Local development (includes instructions)

Copy link

coderabbitai bot commented Jan 8, 2024

Warning

Rate Limit Exceeded

@DemeSzabolcs has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 27 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 Files that changed from the base of the PR and between d410777 and 5734492.

Walkthrough

The project has updated its version control exclusion rules in .gitignore to exclude specific files and directories from version control. Additionally, the Trunk CLI tool has been configured with a new trunk.yaml file. Submodules within the src and test directories, as well as tools, have received updates indicated by changes in commit references. There's also a new guide for YAML linting in GitHub Actions and an update to the spelling exceptions list. Workflow files have been modified to refine CI configurations, including syntax changes and boolean conversions.

Changes

Files Change Summary
.trunk/.gitignore, .trunk/trunk.yaml Introduced exclusion rules for version control; configured Trunk CLI tool.
src/.../Lombiq.*, test/Lombiq.*, tools/Lombiq.* Updated subproject commit references for submodules.
.github/YAMLLinting.md Added documentation for linting YAML files in GitHub Actions.
.github/actions/spelling/allow.txt Added "runtimes" to the spelling exceptions list.
.github/workflows/build-and-test.yml Adjusted syntax and boolean values in CI workflow configurations.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@tteguayco
Copy link
Contributor Author

Hi @DemeSzabolcs ,

Any idea why the pipeline run is red? It looks like it's complaining about a file that hasn't been touched as part of this PR.

@DemeSzabolcs
Copy link
Member

Hello @tteguayco,

It seems like the problem is here: https://github.com/Lombiq/GitHub-Actions/pull/302/files#diff-2c84a15674c9719659b4113e6b1a691c83185924812140d454315e836b5b5b9eR21

You can read the summary here: https://github.com/Lombiq/Open-Source-Orchard-Core-Extensions/actions/runs/7448559535/attempts/1?pr=647

Though I don't see the exact mentioned problem. I think Lombiq.GitHubActions is not updated to the latest OSOCE-188 branch in this PR, thus it's not on this commit yet:
image

Copy link

This pull request has merge conflicts. Please resolve those before requesting a review.

Copy link

This pull request has merge conflicts. Please resolve those before requesting a review.

@DemeSzabolcs DemeSzabolcs merged commit 6bd3322 into dev Jan 26, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants