Add GitHub Actions workflow for Spotless formatting

[nihaltp]

Summary by CodeRabbit

• Chores
  • Added an automated code-formatting workflow that runs on pull requests and main branch, applies project formatting, and commits any resulting fixes back to the branch to keep code consistent and reduce manual formatting work.

[github-actions]

🚀 Hi @nihaltp!

Thank you for contributing to MyCMD. A maintainer will review your PR shortly. 🎉

[coderabbitai]

Warning

Rate limit exceeded

@nihaltp has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 4 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 95661a7 and 568cafb.

📒 Files selected for processing (1)

• .github/workflows/formatter.yml (1 hunks)

Walkthrough

Adds a new GitHub Actions workflow that runs Spotless formatting on pull requests and pushes to the main branch, using JDK 17 and Maven to apply formatting and commit any resulting changes back to the branch.

Changes

Cohort / File(s)	Summary
GitHub Actions — formatter workflow .github/workflows/formatter.yml	New workflow "Apply Spotless Formatting" triggered on PRs and pushes to main; checks out repository, sets up Temurin JDK 17 with Maven caching, runs mvn spotless:apply, and commits formatting changes back to the branch (no-op if no changes).

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant Dev as Developer (PR / Push)
    participant GH as GitHub Actions
    participant Runner as ubuntu-latest
    participant Repo as Repository
    participant Maven as Maven / Spotless
    Dev->>GH: Open PR or push to main
    GH->>Runner: Start "Apply Spotless Formatting" job
    Runner->>Repo: actions/checkout (full fetch)
    Runner->>Runner: setup-java (Temurin 17) + maven cache
    Runner->>Maven: mvn spotless:apply
    alt formatting changes detected
        Maven->>Repo: git commit & push (bot identity)
        Repo->>Dev: Updated PR branch with formatting commits
    else no changes
        Maven->>Runner: output "No changes detected"
    end

Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single YAML workflow file addition.
• Review focus: job triggers, checkout fetch depth, JDK version, Maven cache, commit identity and permissions.

Poem

🐇 I hop through CI with a tidy tune,
Spotless shuffles code beneath the moon,
Maven hums, JDK seventeen bright,
Commits the neatness through the night,
A little rabbit fixes whitespace light.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "Add GitHub Actions workflow for Spotless formatting" accurately and directly describes the main change in the changeset. The PR adds a new GitHub Actions workflow that automates code formatting using Spotless, which aligns perfectly with the title. The title is concise, clear, and avoids vague terms or noise, making it immediately understandable to anyone reviewing the repository history. The specificity of both the action (add), the technology (GitHub Actions workflow), and the purpose (Spotless formatting) provides sufficient context about the primary change.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

.github/workflows/formatter.yml (1)

36-36: Consider restricting git add scope to prevent unintended file commits.

Using git add . commits all modified files in the repository. For a formatting-only workflow, consider being more specific (e.g., common source directories like src/, pom.xml) to reduce the risk of accidentally committing unrelated changes.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0f5fb4f and 1fb4422.

📒 Files selected for processing (1)

• .github/workflows/formatter.yml (1 hunks)

🧰 Additional context used

🪛 actionlint (1.7.8)

.github/workflows/formatter.yml

33-33: "github.head_ref" is potentially untrusted. avoid using it directly in inline scripts. instead, pass it through an environment variable. see https://docs.github.com/en/actions/reference/security/secure-use#good-practices-for-mitigating-script-injection-attacks for more details

(expression)

[github-actions]

🚀 Hi @nihaltp!

Thank you for contributing to MyCMD. A maintainer will review your PR shortly. 🎉

[github-actions]

🚀 Hi @nihaltp!

Thank you for contributing to MyCMD. A maintainer will review your PR shortly. 🎉

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

.github/workflows/formatter.yml (1)

11-13: Optional: Consider adding explicit minimal permissions.

While not required for functionality, explicitly declaring minimal permissions improves security posture. This workflow only needs to push commits:

 jobs:
   format:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     concurrency:

This prevents the workflow from using overly-broad default permissions. However, this is optional.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1fb4422 and 95661a7.

📒 Files selected for processing (1)

• .github/workflows/formatter.yml (1 hunks)

🧰 Additional context used

🪛 actionlint (1.7.8)

.github/workflows/formatter.yml

36-36: "github.head_ref" is potentially untrusted. avoid using it directly in inline scripts. instead, pass it through an environment variable. see https://docs.github.com/en/actions/reference/security/secure-use#good-practices-for-mitigating-script-injection-attacks for more details

(expression)

🔇 Additional comments (2)

.github/workflows/formatter.yml (2)

14-16: ✅ Concurrency constraint properly implemented.

The concurrency block correctly serializes formatter runs per branch, preventing race conditions during git pull --rebase and git push operations. The branch ref fallback github.head_ref || github.ref_name correctly handles both pull_request and push contexts.

---

19-23: ✅ Checkout ref properly handles both contexts.

Using github.head_ref || github.ref_name ensures the step checks out the correct ref for both pull_request events (uses head_ref) and push events (uses ref_name). Full history fetch is appropriate for rebasing.

[github-actions]

🚀 Hi @nihaltp!

Thank you for contributing to MyCMD. A maintainer will review your PR shortly. 🎉