Skip to content

docs(claude): document Flyway migrations in CLAUDE.md#340

Merged
nanotaboada merged 2 commits into
masterfrom
docs/update-claude-md-flyway-migrations
Jun 8, 2026
Merged

docs(claude): document Flyway migrations in CLAUDE.md#340
nanotaboada merged 2 commits into
masterfrom
docs/update-claude-md-flyway-migrations

Conversation

@nanotaboada

@nanotaboada nanotaboada commented Jun 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add Flyway to the Tech Stack section (was adopted in ADR-0012 but never reflected in CLAUDE.md)
  • Add src/main/resources/db/migration/ to the structure diagram with a description of the versioned SQL files
  • Fix the "Modify schema" workflow: replace the stale instruction to manually edit storage/players-sqlite3.db with the correct Flyway-based approach (create a V{N}__...sql migration file); add a note that tests use Spring SQL init (ddl.sql + dml.sql) and not Flyway

Test plan

  • CLAUDE.md Tech Stack lists Flyway with prod/test split noted
  • Structure diagram includes src/main/resources/db/migration/
  • "Modify schema" workflow references Flyway migration files and no longer mentions manual SQLite edits
  • CHANGELOG.md [Unreleased] section updated

Produced with the CLAUDE.md Management plugin

🤖 Generated with Claude Code


This change is Reviewable

Summary by CodeRabbit

  • Documentation
    • Updated database migration workflow documentation to clarify schema modification procedures using versioned migrations instead of manual database edits
    • Added technology stack documentation for Flyway migration tool

Add Flyway to Tech Stack, add db/migration/ to the structure diagram,
and fix the "Modify schema" workflow to use versioned migration files
instead of manually editing the SQLite file. Produced with the
CLAUDE.md Management plugin (https://claude.com/plugins/claude-md-management).

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@nanotaboada, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 54 minutes and 17 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, 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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 111c5c36-0d6f-423f-a2fe-0f6999093f39

📥 Commits

Reviewing files that changed from the base of the PR and between 2a0d097 and 67fb3ff.

📒 Files selected for processing (1)
  • CHANGELOG.md

Walkthrough

This PR updates project documentation to establish Flyway as the schema migration manager. CLAUDE.md is updated to document Flyway versioned SQL migrations under src/main/resources/db/migration/, clarify test initialization, and revise the schema modification workflow to create Flyway migrations instead of manually editing SQLite files. A changelog entry documents these documentation changes.

Changes

Flyway Migration Documentation

Layer / File(s) Summary
Flyway migration approach documentation
CLAUDE.md
Adds explicit note that Flyway manages schema migrations via versioned SQL under db/migration/. Updates project layout documentation to show the Flyway directory structure and clarify that tests use Spring SQL initialization with Flyway disabled. Rewrites the "Modify schema" workflow to create new Flyway migrations, update the Player entity and DTOs, and update test SQL files, removing the prior step of manually modifying the storage/ SQLite database.
Changelog entry for documentation changes
CHANGELOG.md
Documents the updates to CLAUDE.md regarding Flyway tech stack addition, db/migration/ directory documentation, and the revised "Modify schema" workflow.

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title uses Conventional Commits format (docs:), is descriptive and specific about updating CLAUDE.md with Flyway migration documentation, stays well under 80 characters (53 chars), and accurately reflects the main changes in the PR.
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 docs/update-claude-md-flyway-migrations
  • 🛠️ sync documentation
  • 🛠️ enforce http error handling
  • 🛠️ idiomatic review
  • 🛠️ verify api contract

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

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

@codecov

codecov Bot commented Jun 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (a866013) to head (67fb3ff).

Additional details and impacted files
@@             Coverage Diff             @@
##              master      #340   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity        32        32           
===========================================
  Files              3         3           
  Lines             90        90           
  Branches           8         8           
===========================================
  Hits              90        90           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CHANGELOG.md`:
- Line 54: Remove the duplicate "### Changed" heading in the Unreleased block:
keep a single "### Changed" heading and merge any content under the duplicate
into that one (or delete the empty duplicate) so the section headings are unique
and MD024 is resolved; search for the "### Changed" headings in CHANGELOG.md and
consolidate them into a single heading for the Unreleased section.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: cc8274a9-4fcf-4eab-b47e-03feef01d32c

📥 Commits

Reviewing files that changed from the base of the PR and between a866013 and 2a0d097.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • CLAUDE.md

Comment thread CHANGELOG.md Outdated
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@sonarqubecloud

sonarqubecloud Bot commented Jun 8, 2026

Copy link
Copy Markdown

@nanotaboada nanotaboada merged commit 71e6a18 into master Jun 8, 2026
12 checks passed
@nanotaboada nanotaboada deleted the docs/update-claude-md-flyway-migrations branch June 8, 2026 20:03
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