Skip to content

ci: add commitlint workflow and restore UML#45

Merged
liang799 merged 1 commit into
mainfrom
tianpok/add-commitlint-action
Apr 16, 2026
Merged

ci: add commitlint workflow and restore UML#45
liang799 merged 1 commit into
mainfrom
tianpok/add-commitlint-action

Conversation

@liang799
Copy link
Copy Markdown
Owner

@liang799 liang799 commented Apr 16, 2026

Summary by CodeRabbit

  • Documentation

    • Refined sequence diagram for combat mechanics, now featuring focused examples of battle actions including enemy attacks and player defensive responses with damage mitigation effects.
  • Chores

    • Added automated commit message linting via GitHub Actions workflow.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 16, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Two files modified: a new GitHub Actions workflow for commit message linting on pull requests, and a major simplification of a PlantUML sequence diagram that replaces a lengthy multi-round battle walkthrough with two focused combat scenarios.

Changes

Cohort / File(s) Summary
GitHub Actions Configuration
.github/workflows/commitlint.yml
New workflow added to lint commit messages on pull request events and manual dispatch using wagoid/commitlint-github-action@v6.
Documentation & UML Diagrams
docs/uml-diagrams/plantuml_sequence_diagram.puml
Sequence diagram drastically simplified: removes full multi-round custom-mode walkthrough and replaces it with two focused scenarios demonstrating basic attack and defend actions with status-effect handling. Control flow refactored to show engine→turn-processor→decision-provider composition with explicit action execution and damage adjustment logic.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • PR #42: Adds getTurnBlockReason and status-effect registry APIs that are explicitly referenced in the revised sequence diagram's control flow.
  • PR #31: Refactors battle engine architecture toward turn-processor delegation and action-class composition, which aligns with the new sequence diagram's design.
  • PR #44: Concurrently modifies the same PlantUML sequence diagram file with layout and activation adjustments.

Poem

🐰 A workflow springs forth to lint each commit with care,
While diagrams dance—simplified, lean, and fair!
From eight rounds of chaos to two focused scenes,
Turn processing flows through the battle machine. 🎮✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects both main changes: adding a commitlint CI workflow and updating the UML sequence diagram, making it clear and specific.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch tianpok/add-commitlint-action

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

@liang799 liang799 merged commit 28b0c70 into main Apr 16, 2026
3 of 4 checks passed
@liang799 liang799 deleted the tianpok/add-commitlint-action branch April 16, 2026 11:28
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.

1 participant