Skip to content

chore(ci): fmt yaml files#5827

Merged
LesnyRumcajs merged 4 commits intomainfrom
fmt-yaml-ci
Jul 10, 2025
Merged

chore(ci): fmt yaml files#5827
LesnyRumcajs merged 4 commits intomainfrom
fmt-yaml-ci

Conversation

@LesnyRumcajs
Copy link
Copy Markdown
Member

@LesnyRumcajs LesnyRumcajs commented Jul 10, 2025

Summary of changes

Changes introduced in this pull request:

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

  • Chores
    • Standardized YAML formatting across configuration and workflow files by updating quotation styles and array syntax.
    • Added a new YAML linting job to the scripts lint workflow for improved consistency checks.
    • Introduced npm scripts for formatting and checking YAML files.
    • Made minor formatting adjustments in Docker Compose files without affecting service logic or behavior.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 10, 2025

Warning

Rate limit exceeded

@LesnyRumcajs has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 52 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 10a0b86 and 5ed220c.

📒 Files selected for processing (4)
  • .github/workflows/butterflynet.yml (2 hunks)
  • .github/workflows/docker.yml (7 hunks)
  • .github/workflows/forest.yml (23 hunks)
  • .github/workflows/rpc_test_repeat.yml (2 hunks)

Walkthrough

This update standardizes YAML and JSON formatting across workflow, configuration, and Docker Compose files. It replaces single quotes with double quotes, removes extraneous spaces in array syntax, adjusts indentation, and adds newline consistency. Additionally, two new npm scripts for YAML formatting and checking are introduced, along with a new YAML lint job in the scripts lint workflow.

Changes

File(s) Change Summary
.github/ISSUE_TEMPLATE/config.yml Reduced indentation for contact_links list items.
.github/dependabot.yml, .github/workflows/curio-devnet-publish.yml, .github/workflows/lotus-devnet-publish.yml Added or removed trailing blank lines for consistency.
.github/workflows/docker-latest-tag.yml, .github/workflows/release_dispatch.yml, .github/workflows/rpc_test_repeat.yml Replaced single quotes with double quotes in workflow_dispatch input descriptions and related fields.
.github/workflows/docker.yml, .github/workflows/dockerfile-check.yml, .github/workflows/docs-check.yml, Replaced single quotes with double quotes for string literals, paths, and environment variables in workflows.
.github/workflows/docs-deploy.yml, .github/workflows/docs-required-override.yml, .github/workflows/forest.yml, .github/workflows/rust-lint.yml Standardized quoting style and concurrency expressions to use double quotes.
.github/workflows/scripts-lint.yml Changed version strings to double quotes and added a new yaml-lint job for YAML linting.
monitored-stack/grafana/provisioning/dashboards/dashboard.yml Converted provider mapping to a list, updated quotes, and adjusted indentation.
monitored-stack/prometheus/prometheus.yml Changed single quotes to double quotes for job_name and targets.
package.json Added yaml-fmt and yaml-check npm scripts for YAML formatting and checking.
scripts/devnet-curio/docker-compose.yml, scripts/devnet/docker-compose.yml, scripts/tests/api_compare/docker-compose.yml, scripts/tests/bootstrapper/docker-compose-forest.yml, scripts/tests/bootstrapper/docker-compose-lotus.yml Removed spaces inside array brackets in entrypoint and related fields; reformatted command arrays.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant CI
    participant LintJob

    Developer->>CI: Push code or open PR
    CI->>LintJob: Trigger scripts-lint workflow
    LintJob->>LintJob: Run markdown and script linters
    LintJob->>LintJob: Run yaml-lint job (Node.js setup, yarn install, yaml-check)
    LintJob-->>CI: Report lint results
    CI-->>Developer: Pass/fail status
Loading

Poem

A hop, a skip, a tidy sweep,
Double quotes where single sleep.
Arrays aligned, with spaces trimmed,
YAML checked, the errors dimmed.
Scripts and workflows, neat and bright—
This bunny loves a file done right!
🐇✨


🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

@LesnyRumcajs LesnyRumcajs marked this pull request as ready for review July 10, 2025 12:41
@LesnyRumcajs LesnyRumcajs requested a review from a team as a code owner July 10, 2025 12:41
@LesnyRumcajs LesnyRumcajs requested review from elmattic and sudo-shashank and removed request for a team July 10, 2025 12:41
hanabi1224
hanabi1224 previously approved these changes Jul 10, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

♻️ Duplicate comments (4)
.github/workflows/docker.yml (2)

6-6: Same boolean/string issue as in forest.yml.
cancel-in-progress is now quoted – see previous comment for the rationale and fix.


60-61: Same integer/string issue for timeout-minutes.
Remove the surrounding quotes to keep the value numeric.

.github/workflows/rust-lint.yml (1)

28-29: AWS_* quoting change is fine.
However, cancel-in-progress and all timeout-minutes fields suffer from the same mis-typing noted earlier. Apply the same fix.

.github/workflows/docs-required-override.yml (1)

6-8: cancel-in-progress is quoted here as well; please drop the quotes to keep it boolean.

🧹 Nitpick comments (2)
.github/workflows/scripts-lint.yml (1)

74-84: Nice addition of YAML linting – consider caching ~/.cache/yarn for speed.

Repeated installs on every run add ~20-30 s. Adding a simple cache step speeds up the job:

      - uses: actions/setup-node@v4
        with:
          node-version: "18"
+      - name: Yarn cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/yarn
+          key: yarn-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            yarn-${{ runner.os }}-
       - run: corepack enable
       - run: yarn --immutable
       - run: yarn yaml-check
monitored-stack/grafana/provisioning/dashboards/dashboard.yml (1)

6-7: Minor: empty folder can be left unquoted
Since the value is an empty string, you can omit the quotes (folder: ""folder: '' or simply remove the key if the default root folder is intended). Totally optional—feel free to keep as-is for consistency with the linter’s style.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 631e7b1 and f057de0.

📒 Files selected for processing (23)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
  • .github/dependabot.yml (1 hunks)
  • .github/workflows/curio-devnet-publish.yml (0 hunks)
  • .github/workflows/docker-latest-tag.yml (1 hunks)
  • .github/workflows/docker.yml (7 hunks)
  • .github/workflows/dockerfile-check.yml (1 hunks)
  • .github/workflows/docs-check.yml (1 hunks)
  • .github/workflows/docs-deploy.yml (1 hunks)
  • .github/workflows/docs-required-override.yml (2 hunks)
  • .github/workflows/forest.yml (23 hunks)
  • .github/workflows/lotus-devnet-publish.yml (0 hunks)
  • .github/workflows/release_dispatch.yml (1 hunks)
  • .github/workflows/rpc_test_repeat.yml (2 hunks)
  • .github/workflows/rust-lint.yml (1 hunks)
  • .github/workflows/scripts-lint.yml (3 hunks)
  • monitored-stack/grafana/provisioning/dashboards/dashboard.yml (1 hunks)
  • monitored-stack/prometheus/prometheus.yml (1 hunks)
  • package.json (1 hunks)
  • scripts/devnet-curio/docker-compose.yml (8 hunks)
  • scripts/devnet/docker-compose.yml (7 hunks)
  • scripts/tests/api_compare/docker-compose.yml (14 hunks)
  • scripts/tests/bootstrapper/docker-compose-forest.yml (8 hunks)
  • scripts/tests/bootstrapper/docker-compose-lotus.yml (7 hunks)
💤 Files with no reviewable changes (2)
  • .github/workflows/lotus-devnet-publish.yml
  • .github/workflows/curio-devnet-publish.yml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
  • GitHub Check: Build forest binaries on Linux AMD64
  • GitHub Check: tests-release
  • GitHub Check: tests
  • GitHub Check: Build Ubuntu
  • GitHub Check: cargo-publish-dry-run
  • GitHub Check: All lint checks
🔇 Additional comments (16)
scripts/devnet/docker-compose.yml (1)

32-32: Formatting-only edits look correct

Whitespace inside the inline array literals (entrypoint: [...]) and the stray trailing space in the forest-tool api serve command have been removed. This is purely cosmetic and does not change how Docker Compose interprets the file. No other issues spotted.

Also applies to: 85-85, 129-130, 164-164, 216-216, 265-265, 273-274, 289-289

scripts/tests/bootstrapper/docker-compose-lotus.yml (1)

15-15: Consistent array-style linting – no functional impact

All touched lines swap [ "/bin/bash", "-c" ]["/bin/bash", "-c"] and trim a dangling space on --stateless. These satisfy the new YAML-lint rules and leave the container behaviour unchanged.

Also applies to: 44-44, 54-55, 72-72, 90-90, 109-109

scripts/tests/api_compare/docker-compose.yml (1)

15-15: YAML-lint conformance achieved

The entrypoint / health-check list literals are now space-free, matching the formatter’s expectations. No semantic differences detected across any of the edited services.

Also applies to: 46-46, 61-62, 70-70, 85-85, 105-105, 133-133, 140-140, 165-165, 183-183, 229-229, 265-265, 285-285, 299-299

scripts/devnet-curio/docker-compose.yml (1)

31-31: Nice readability & lint fixes

– Inline-list whitespace trimmed on every entrypoint.
– Yugabyte command rewritten as a clean multi-line list: 👍 for readability; behaviour identical.
No further remarks.

Also applies to: 80-80, 123-123, 155-155, 206-206, 231-231, 268-268, 282-288

scripts/tests/bootstrapper/docker-compose-forest.yml (1)

15-15: Minor whitespace cleanup approved

Uniform list-style formatting and removal of a dangling space after --stateless. Docker Compose semantics stay intact.

Also applies to: 43-43, 54-55, 69-69, 90-90, 112-112, 132-132

.github/workflows/dockerfile-check.yml (1)

8-8: Consistent quoting style looks good

Switching the cron expression to double quotes aligns with the new YAML-lint requirements and doesn’t change the schedule semantics.

monitored-stack/prometheus/prometheus.yml (1)

5-7: Uniform quoting applied correctly

Double-quoting job_name and targets keeps the config valid and passes stricter linters. No functional impact.

.github/workflows/release_dispatch.yml (1)

8-8: Minor style change acknowledged

The description field now uses double quotes; matches repository-wide convention and is YAML-safe.

.github/dependabot.yml (1)

52-52: Final newline added

Adds the missing newline at EOF—good for tooling and POSIX compliance.

.github/workflows/docs-deploy.yml (1)

8-9: Path strings re-quoted successfully

The paths in both triggers now use double quotes, matching the linter’s preferred style; behaviour unchanged.

Also applies to: 15-16

.github/ISSUE_TEMPLATE/config.yml (1)

3-11: Indentation adjustment is correct and improves YAML validity

The items are now properly nested under contact_links, eliminating subtle parser pitfalls and improving readability.

.github/workflows/docker-latest-tag.yml (1)

9-15: LGTM – quoting style brought in line with repo conventions

Switching to double quotes is purely cosmetic here and keeps the workflows consistent.

.github/workflows/rpc_test_repeat.yml (1)

7-10: Cosmetic quoting change – looks fine

No functional impact; good for consistency.

.github/workflows/docs-check.yml (1)

13-24: Path-filter quoting standardized – all good

The switch to double quotes keeps pattern syntax intact and matches other workflow files.

package.json (1)

11-13: Helpful addition of YAML format / check scripts

Covers both .yml and .yaml extensions and plugs neatly into CI.

monitored-stack/grafana/provisioning/dashboards/dashboard.yml (1)

3-11: Provider block moved to list form – looks correct
Converting the single provider mapping into a one-element list matches Grafana’s documented schema, and all keys/indentation pass YAML-lint. No functional issues spotted.

Comment thread .github/workflows/rpc_test_repeat.yml Outdated
Comment thread .github/workflows/forest.yml Outdated
Comment thread .github/workflows/forest.yml Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@LesnyRumcajs LesnyRumcajs added this pull request to the merge queue Jul 10, 2025
Merged via the queue into main with commit 44616e8 Jul 10, 2025
46 checks passed
@LesnyRumcajs LesnyRumcajs deleted the fmt-yaml-ci branch July 10, 2025 13:37
@coderabbitai coderabbitai Bot mentioned this pull request Jan 8, 2026
4 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Jan 20, 2026
4 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Feb 24, 2026
6 tasks
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