Skip to content

style: clear lint debt before the lint CI lands - #204

Merged
DevSecNinja merged 1 commit into
mainfrom
steward/lint-debt
Nov 17, 2026
Merged

DevSecNinja merged 1 commit into
mainfrom
steward/lint-debt

Conversation

@DevSecNinja

@DevSecNinja DevSecNinja commented Nov 16, 2026 •

Copy link
Copy Markdown
Owner

Clears the lint debt that the standard lint CI would report, so the caller PR stacked on top (#205) is green from its first run. All changes are mechanical, with no behaviour change.

  • Central configs from DevSecNinja/.github config-sync/files at v4.2.0, unchanged, so config-sync later finds no drift: dprint.json, .yamllint.yaml, .yamlfmt.yaml and .editorconfig. .editorconfig sets 4-space indentation for shell scripts, which most of them already use. The repo's own .yamllint still takes precedence for yamllint.
  • dprint: Markdown formatting.
  • yamlfmt:
    • document start markers and block-style lists in the Taskfile and the Ansible roles;
    • on each file's last block scalar, |/> becomes |-/>-, which drops one trailing newline from a debug message;
    • I checked that every reformatted file parses to the same data apart from that.
  • shfmt: indentation in three scripts.
  • shellcheck SC2086: quotes $EXIT_CODE in tests/bash/run-tests.sh.

Opened by repo-steward (lint rollout batch B2). Review and merge this first, then #205.

Refs #203

Summary by CodeRabbit

  • Style
    • Standardized formatting across project documentation, configuration, scripts, and automation files without changing task behavior.
    • Added consistent YAML and Markdown formatting rules.
  • Documentation
    • Clarified descriptions of Bash test coverage, including repository setup and CI checks.
    • Improved spacing and layout across setup, maintenance, and testing guides.
  • Chores
    • Updated test-runner formatting while preserving its existing test execution and CI reporting behavior.

Clear the lint debt the standard lint CI would report, mechanically and
with no behaviour change, before the callers land (stacked PR on top):

- Add the central lint configs from DevSecNinja/.github config-sync/files
  at v4.2.0, unchanged: dprint.json, .yamllint.yaml, .yamlfmt.yaml and
  .editorconfig (4-space shell indentation, which the scripts already use).
  The repo's own .yamllint still takes precedence for yamllint.
- dprint: Markdown formatting.
- yamlfmt: document start markers, block lists, and `|-`/`>-` on a
  file's last block scalar (drops one trailing newline of a debug
  message). Every reformatted file parses to the same data otherwise.
- shfmt: indentation in three scripts; shellcheck SC2086: quote
  $EXIT_CODE in tests/bash/run-tests.sh.

Refs #203
Copilot AI balanced review requested due to automatic review settings November 16, 2026 21:10
@coderabbitai

coderabbitai Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

This pull request adds editor and formatting configurations. It applies formatting changes to documentation, Taskfile commands, Ansible YAML, and Bash scripts. The Bash test runner also quotes its exit-code comparison variable.

Changes: Repository formatting and lint preparation

Layer / File(s) Summary
Formatting configuration and repository instructions
.editorconfig, .yamlfmt.yaml, .yamllint.yaml, dprint.json, .devcontainer/*, .github/copilot-instructions.md, INSTALL.md, README.md, Taskfile.yml, docs/tools/MISE.md
Adds EditorConfig, yamlfmt, yamllint, and dprint settings. Documentation spacing and Taskfile formatting changed; existing guidance and commands remain unchanged.
Ansible YAML and shell formatting
ansible/README.md, ansible/playbooks/main.yml, ansible/roles/*, ansible/scripts/ansible-pull.sh
Reformats Ansible tags and selected YAML values. Existing tag values, task behavior, and shell check behavior remain unchanged.
Bash test runner formatting
tests/bash/README.md, tests/bash/run-tests.sh
Reformats the test runner and its documentation. Existing runner behavior remains unchanged, and the exit-code comparison now quotes EXIT_CODE.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: copilot

Merge Risk: Minimal · up to 2fafc

This is a formatting and lint-preparation change with no intended behavior change. The only difference is a trailing newline dropped from a few debug messages. It looks safe to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "style: clear lint debt before the lint CI lands" matches the main change. The PR adds lint and format configs (dprint.json, .yamllint.yaml, .yamlfmt.yaml, .editorconfig), applies Markdown, …
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "style: clear lint debt before the lint CI lands" matches the main change. The PR adds lint and format configs (dprint.json, .yamllint.yaml, .yamlfmt.yaml, .editorconfig), applies Markdown, YAML, and shell formatting, converts inline YAML tag lists to block lists, and quotes $EXIT_CODE for shellcheck SC2086. The title is concise, uses a conventional commit prefix, and states the purpose of the change.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c65b4c72-2c47-407d-9e64-7f4868b154f1
Commits

Reviewing files that changed from the base of the PR and between d1b1fc5 and 2fafc3b.

Files selected for processing: 36

  • .devcontainer/README.md
  • .devcontainer/post-create.sh
  • .editorconfig
  • .github/copilot-instructions.md
  • .yamlfmt.yaml
  • .yamllint.yaml
  • INSTALL.md
  • README.md
  • Taskfile.yml
  • ansible/README.md
  • ansible/playbooks/main.yml
  • ansible/roles/ansible_pull_setup/defaults/main.yml
  • ansible/roles/ansible_pull_setup/tasks/main.yml
  • ansible/roles/apt_hold/tasks/main.yml
  • ansible/roles/apt_hold/tasks/unhold.yml
  • ansible/roles/chezmoi/tasks/main.yml
  • ansible/roles/cron_jobs/tasks/main.yml
  • ansible/roles/devcontainer_prebuild/tasks/main.yml
  • ansible/roles/git_repos/tasks/clone_shim.yml
  • ansible/roles/git_repos/tasks/github_user.yml
  • ansible/roles/git_repos/tasks/main.yml
  • ansible/roles/github_ssh_keys/tasks/main.yml
  • ansible/roles/maintenance/tasks/docker_maintenance.yml
  • ansible/roles/maintenance/tasks/main.yml
  • ansible/roles/package_managers/tasks/install_homebrew.yml
  • ansible/roles/package_managers/tasks/install_mise.yml
  • ansible/roles/package_managers/tasks/main.yml
  • ansible/roles/packages/tasks/main.yml
  • ansible/roles/system_setup/handlers/main.yml
  • ansible/roles/system_setup/tasks/main.yml
  • ansible/roles/ufw/defaults/main.yml
  • ansible/scripts/ansible-pull.sh
  • docs/tools/MISE.md
  • dprint.json
  • tests/bash/README.md
  • tests/bash/run-tests.sh

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues are recorded for the shared lint configuration and formatting cleanup.

No open issues 🎉

What changed in this PR

Prepares the Ansible Pull infrastructure repository for the lint CI in #205, supporting #203, by adding shared configuration and clearing formatting debt.

Changes:

  • Adds central dprint, yamlfmt, yamllint, and EditorConfig settings.
  • Reformats Markdown and YAML, including block-style lists and trailing-newline trimming in debug messages.
  • Normalizes shell formatting and quotes $EXIT_CODE in the test runner.
File Description
tests/​bash/​run-tests.sh Normalizes indentation and quotes exit-code references.
tests/​bash/​README.md Adds Markdown spacing around lists.
Taskfile.yml Adds a YAML document marker and reflows commands.
README.md Formats the command table and Markdown spacing.
INSTALL.md Adds spacing before a list.
dprint.json Adds shared Markdown formatter settings and exclusions.
docs/​tools/​MISE.md Adds spacing before a list.
ansible/​scripts/​ansible-pull.sh Normalizes shell redirection spacing.
ansible/​roles/​ufw/​defaults/​main.yml Normalizes inline-comment spacing.
ansible/​roles/​system_setup/​tasks/​main.yml Converts task tags to block lists.
ansible/​roles/​system_setup/​handlers/​main.yml Converts handler tags to block lists.
ansible/​roles/​packages/​tasks/​main.yml Converts task tags to block lists.
ansible/​roles/​package_managers/​tasks/​main.yml Converts task tags to block lists.
ansible/​roles/​package_managers/​tasks/​install_mise.yml Converts task tags to block lists.
ansible/​roles/​package_managers/​tasks/​install_homebrew.yml Converts task tags to block lists.
ansible/​roles/​maintenance/​tasks/​main.yml Strips the final newline from a debug message.
ansible/​roles/​maintenance/​tasks/​docker_maintenance.yml Strips the final newline from a debug message.
ansible/​roles/​github_ssh_keys/​tasks/​main.yml Formats accepted HTTP statuses as a block list.
ansible/​roles/​git_repos/​tasks/​main.yml Formats tags and consolidates a loop expression.
ansible/​roles/​git_repos/​tasks/​github_user.yml Converts task tags to block lists.
ansible/​roles/​git_repos/​tasks/​clone_shim.yml Formats tags and inline lint-suppression comments.
ansible/​roles/​devcontainer_prebuild/​tasks/​main.yml Converts task tags to block lists.
ansible/​roles/​cron_jobs/​tasks/​main.yml Converts task tags to block lists.
ansible/​roles/​chezmoi/​tasks/​main.yml Wraps the ARM64 download URL expression.
ansible/​roles/​apt_hold/​tasks/​unhold.yml Converts task tags to a block list.
ansible/​roles/​apt_hold/​tasks/​main.yml Converts task tags to a block list.
ansible/​roles/​ansible_pull_setup/​tasks/​main.yml Strips the final newline from a debug message.
ansible/​roles/​ansible_pull_setup/​defaults/​main.yml Normalizes inline-comment spacing.
ansible/​README.md Adds Markdown spacing around headings and lists.
ansible/​playbooks/​main.yml Converts role tags to block lists.
.yamllint.yaml Adds central YAML lint rules and exclusions.
.yamlfmt.yaml Adds central YAML formatting settings and exclusions.
.github/​copilot-instructions.md Formats Markdown without changing instruction content.
.editorconfig Defines shared whitespace, indentation, and newline settings.
.devcontainer/​README.md Adds Markdown spacing before lists.
.devcontainer/​post-create.sh Normalizes shell indentation and comment alignment.

Review effort: Balanced

@DevSecNinja
DevSecNinja merged commit 5ed18ee into main Nov 17, 2026
4 checks passed
@DevSecNinja
DevSecNinja deleted the steward/lint-debt branch November 17, 2026 12:42
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.

2 participants