chore(ci): fmt yaml files#5827
Conversation
|
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 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. 📒 Files selected for processing (4)
WalkthroughThis 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
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
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (4)
.github/workflows/docker.yml (2)
6-6: Same boolean/string issue as inforest.yml.
cancel-in-progressis now quoted – see previous comment for the rationale and fix.
60-61: Same integer/string issue fortimeout-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-progressand alltimeout-minutesfields suffer from the same mis-typing noted earlier. Apply the same fix..github/workflows/docs-required-override.yml (1)
6-8:cancel-in-progressis 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/yarnfor 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-checkmonitored-stack/grafana/provisioning/dashboards/dashboard.yml (1)
6-7: Minor: emptyfoldercan 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
📒 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 correctWhitespace inside the inline array literals (
entrypoint: [...]) and the stray trailing space in theforest-tool api servecommand 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 impactAll 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 achievedThe 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.
– Yugabytecommandrewritten 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 approvedUniform 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 goodSwitching 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 correctlyDouble-quoting
job_nameandtargetskeeps the config valid and passes stricter linters. No functional impact..github/workflows/release_dispatch.yml (1)
8-8: Minor style change acknowledgedThe description field now uses double quotes; matches repository-wide convention and is YAML-safe.
.github/dependabot.yml (1)
52-52: Final newline addedAdds the missing newline at EOF—good for tooling and POSIX compliance.
.github/workflows/docs-deploy.yml (1)
8-9: Path strings re-quoted successfullyThe 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 validityThe 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 conventionsSwitching 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 fineNo functional impact; good for consistency.
.github/workflows/docs-check.yml (1)
13-24: Path-filter quoting standardized – all goodThe switch to double quotes keeps pattern syntax intact and matches other workflow files.
package.json (1)
11-13: Helpful addition of YAML format / check scriptsCovers both
.ymland.yamlextensions 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.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Summary of changes
Changes introduced in this pull request:
Reference issue to close (if applicable)
Closes
Other information and links
Change checklist
Summary by CodeRabbit