Skip to content

feat: add docker-status command to Makefile - #48

Merged
susumutomita merged 1 commit into
mainfrom
feature/add-container-status
Nov 20, 2025
Merged

susumutomita merged 1 commit into
mainfrom
feature/add-container-status

Conversation

@susumutomita

@susumutomita susumutomita commented Nov 20, 2025 •

Copy link
Copy Markdown
Owner
  • Added docker-status target to show container status
  • Updated help section in Makefile
  • Updated QUICKSTART.md with new command usage
  • Recorded execution plan in Plan.md

Refs: Plan.md "Makefile 改善: Docker ステータス確認コマンドの追加"

Summary by CodeRabbit

  • New Features

    • Added make docker-status command to display the running status of Keycloak, Control Plane UI, and all Docker containers with fallback messaging for missing containers.
  • Documentation

    • Updated quickstart guide with instructions for checking container health status during troubleshooting.

✏️ Tip: You can customize this high-level summary in your review settings.

- Added docker-status target to show container status
- Updated help section in Makefile
- Updated QUICKSTART.md with new command usage
- Recorded execution plan in Plan.md

Refs: Plan.md "Makefile 改善: Docker ステータス確認コマンドの追加"
@susumutomita
susumutomita enabled auto-merge (squash) November 20, 2025 00:03
@coderabbitai

coderabbitai Bot commented Nov 20, 2025 •

Copy link
Copy Markdown

Walkthrough

The PR introduces a new docker-status Makefile target that reports the operational state of Keycloak, Control Plane UI, and all running containers using Docker commands. Documentation updates in Plan.md and QUICKSTART.md explain the new command's usage for users troubleshooting container health.

Changes

Cohort / File(s) Summary
Makefile improvements
Makefile
Added docker-status target with Docker Compose and Docker CLI calls to display container statuses; expanded .PHONY declaration to include the new target; updated help text to document the make docker-status command
Documentation updates
Plan.md, docs/QUICKSTART.md
Plan.md added planning block(s) describing the docker-status feature; QUICKSTART.md added new sections and troubleshooting guidance for users to check container status using the new Makefile target

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

  • Makefile additions are straightforward echo statements and Docker command calls with minimal logic
  • Documentation changes are largely repetitive explanatory text with no semantic complexity
  • No interdependencies or control-flow changes requiring deep analysis

Possibly related PRs

Poem

🐰 A status checker hops into view,
docker-status shows what containers do—
Keycloak and Control Plane on display,
No more guessing—just make your way! 🚀

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and specifically describes the main change: adding a docker-status command to the Makefile, which is the primary feature introduced across all modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/add-container-status

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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.

@claude

claude Bot commented Nov 20, 2025

Copy link
Copy Markdown

PR Review: feat: add docker-status command to Makefile

Summary

This PR adds a docker-status command to the Makefile to help developers quickly check the status of Docker containers. Overall, this is a useful addition that improves developer experience.


✅ Positives

  1. Good developer experience improvement - The docker-status command provides a convenient one-stop way to check all container statuses
  2. Consistent styling - Uses the same formatting patterns (emojis, dividers) as other Makefile targets
  3. Proper dependency - Correctly depends on check-docker to validate Docker is running
  4. Documentation update - QUICKSTART.md is updated with the new command usage
  5. Plan.md updated - Follows project conventions by recording the execution plan

🐛 Issue Found

Duplicate section in docs/QUICKSTART.md (lines 363-365)

The diff shows a duplicate "Keycloak:" label in the documentation:

**Keycloak**:

**Keycloak**:
```bash
cd infrastructure/docker/keycloak
docker compose logs -f keycloak

This appears to be an unintended duplicate. The first "Keycloak:" (line 363) should likely be removed or the content reorganized.


💡 Minor Suggestions

  1. Consider adding --exit-code-from behavior - Currently, docker compose ps returns success even if containers are stopped. For CI/scripting use cases, you might want to add an option or note about checking actual running state.

  2. Error handling consistency - The fallback messages (e.g., "❌ Keycloak コンテナが見つかりません") are good, but note that docker compose ps in a directory without a docker-compose.yml will show an error, not trigger the || echo fallback. The current implementation works fine for the intended use case though.

  3. Help section organization - The docker-status command is placed in the "Docker ビルド" section. It might fit better semantically in the "ローカル環境管理" section alongside check-docker, but this is a minor organizational preference.


🔒 Security Concerns

None identified.


🧪 Test Coverage

N/A - This is a Makefile target addition with documentation updates. No code tests required.


Verdict

Approve with minor fix required - Please fix the duplicate "Keycloak:" label in QUICKSTART.md before merging.


🤖 Generated with Claude Code

@susumutomita
susumutomita merged commit 8c9619e into main Nov 20, 2025
7 of 8 checks passed
@susumutomita
susumutomita deleted the feature/add-container-status branch November 20, 2025 00:05

@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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fb5dcc7 and 9fe58bd.

📒 Files selected for processing (3)
  • Makefile (3 hunks)
  • Plan.md (1 hunks)
  • docs/QUICKSTART.md (2 hunks)
🧰 Additional context used
🪛 checkmake (0.2.2)
Makefile

[warning] 1-1: Missing required phony target "all"

(minphony)

⏰ 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). (1)
  • GitHub Check: claude-review
🔇 Additional comments (5)
Makefile (3)

1-1: PHONY targets correctly updated.

The docker-status target is properly declared in the PHONY list.


141-157: docker-status target implementation is sound.

The target correctly depends on check-docker, displays status information with user-friendly formatting, and provides fallback error messages for missing containers. The use of || ensures graceful degradation when docker compose is unavailable in certain directories.


174-174: Help text correctly updated.

The make docker-status command is properly documented in the help output with a clear description.

Plan.md (1)

738-765: Execution plan is well-structured and follows established patterns.

The new docker-status execution plan section adheres to the document's structure (Objective, Guardrails, Tasks, Validation, Progress Log) and clearly documents the completed work with timestamps. All tasks are marked complete, and validation steps align with the Makefile implementation.

docs/QUICKSTART.md (1)

220-228: Container status check documentation is clear and well-placed.

The new troubleshooting subsection "コンテナの状態を確認する" effectively guides users to the make docker-status command with a concise explanation of what it displays.

Comment thread docs/QUICKSTART.md
Comment on lines +358 to 365
**コンテナの状態確認**:
```bash
make docker-status
```

**Keycloak**:

**Keycloak**:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Formatting inconsistency: duplicate Keycloak heading detected.

Lines 358-361 introduce a "コンテナの状態確認" subsection, but lines 363 and 365 both show "Keycloak:" as a heading, creating redundancy. This appears to be a copy-paste artifact from the section organization.

Suggest removing the duplicate or restructuring the section:

 ### ログを確認
 
-**コンテナの状態確認**:
-```bash
-make docker-status
-```
-
-**Keycloak**:
-**Keycloak**:
-```bash
+**Keycloak**:
+```bash

Alternatively, if you intend to keep both sections, ensure they have distinct purposes or consolidate them.

🤖 Prompt for AI Agents
In docs/QUICKSTART.md around lines 358 to 365 there is a duplicated
"**Keycloak**:" heading (likely a copy-paste artifact) that creates a formatting
inconsistency; remove the duplicate heading and consolidate the block so it
reads a single "**Keycloak**:" heading followed by the intended code block (or,
if two distinct sections are required, rename one to reflect its different
purpose) ensuring proper markdown code fence placement for the bash snippet.

susumutomita added a commit that referenced this pull request Jun 7, 2026
The README claimed 112 public problems (108 Challenge) and linked a
non-existent problems/CERTIFICATION-INDEX.md. The catalog repo added 105
cert labs (#46) then deliberately removed 107 low-quality challenges (#48),
so the currently pinned submodule holds only 6 problems (4 Battle, 2
Challenge, 1 bundle). Align the README with the real pinned catalog and
point readers to problems/CATALOG.md as the always-current source of truth.

Also fix doc references that pointed at paths/links that do not exist:

- AGENTS.md / MODULE_MAP: the harness rule logic is not in
  .claude/harness/src/architecture.ts (no such file). Entry points are
  bin/architecture.ts / bin/tech-debt.ts; rules live one-per-file under
  src/rules/ and src/tech-debt/.
- GLOSSARY: "ADR-008" was hyperlinked to the unrelated
  adr-003-problem-catalog-ddb.html (ADR-008 has no HTML file). Un-link it
  to match the other plain-text ADR-008 references.

Regenerate the GLOSSARY/MODULE_MAP HTML mirrors via build-docs.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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