Skip to content

RHOAIENG-51548: fix: replace dev-* Makefile targets with local-*#784

Open
mprpic wants to merge 1 commit intomainfrom
fix/stale-dev-targets-in-makefile
Open

RHOAIENG-51548: fix: replace dev-* Makefile targets with local-*#784
mprpic wants to merge 1 commit intomainfrom
fix/stale-dev-targets-in-makefile

Conversation

@mprpic
Copy link
Contributor

@mprpic mprpic commented Mar 3, 2026

The CRC-based dev-* targets (dev-logs, dev-start, dev-stop, etc.) were replaced with local-* equivalents in 5553056 but docs were never updated to reflect this changes.

The CRC-based dev-* targets (dev-logs, dev-start, dev-stop, etc.)
were replaced with local-* equivalents in 5553056 but docs were never
updated to reflect this changes.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Martin Prpič <mprpic@redhat.com>
@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2026

Claude Code Review

Summary

PR #784 is a documentation-only fix that updates stale dev-* Makefile target references to their local-* replacements across 7 files. The changes are accurate and consistently applied. No production code, security logic, or APIs are modified — all backend/frontend/security checklist items are N/A.

Issues by Severity

Blocker Issues

None

Critical Issues

None

Major Issues

None

Minor Issues

1. Stale DEV_MODE=true reference in crc.md Features section

File: docs/internal/developer/local-development/crc.md

The PR updates the "Hot-Reloading Development" workflow section (replacing the two-terminal DEV_MODE=true + make dev-sync pattern with make local-rebuild), but the Features section lower in the file was not touched:

### Development Workflow
- Hot-reloading with `DEV_MODE=true`   <- stale, not removed/updated
- Rebuild with `make local-rebuild`

This contradicts the corrected workflow described just above it and could mislead developers into trying a mode that no longer exists. Suggest removing or updating the DEV_MODE=true bullet.


2. Misleading guidance in "Need OpenShift-Specific Features?" section

File: docs/internal/developer/local-development/README.md (around line 227)

Before the patch, this section explicitly said "CRC-based" and pointed to make dev-start. After the patch, it now points to make local-up with the comment "minikube-based", but the surrounding prose still reads:

### Need OpenShift-Specific Features?
Use **CRC** only if you need Routes, BuildConfigs, etc:
make local-up  # Local dev (minikube-based)

Directing developers who need CRC/OpenShift-specific features to the minikube-based make local-up is incorrect — minikube does not provide Routes or BuildConfigs. The section either needs a separate CRC command (if one still exists) or the prose should be updated to clarify that CRC-only features are no longer a supported local-dev path.


3. Missing replacement for "Stop and shutdown CRC" in cleanup section

File: docs/internal/developer/local-development/crc.md

The old cleanup table had three actions; the new one has two:

Old New
make dev-stop (Stop, keep CRC running) make local-down (Stop, keep cluster running)
make dev-stop-cluster (Stop and shutdown CRC) (removed, no replacement documented)
make dev-clean (Full cleanup, deletes CRC) make local-clean (Full cleanup, deletes cluster)

If make dev-stop-cluster was intentionally removed because the underlying target was deleted in commit 5553056, a brief note explaining how to shut down the cluster (minikube stop / kind delete cluster) would help developers who land on this page.

Positive Highlights

  • Consistent replacement across all 7 files — every occurrence of dev-start, dev-sync, dev-test, dev-stop, dev-clean, dev-logs, dev-restart-operator, and dev-operator-status was caught and updated. No stragglers in the diff.
  • Diagram updates are accurate — the .mmd files have matching node labels and CSS class assignments updated in lockstep, so the rendered diagrams will remain consistent.
  • Good clarification on Kind vs. Minikubecomponents/README.md now clearly documents both cluster options and calls out Kind as the recommended choice, which was absent before.
  • Removal of the misleading test-count comment — the # Should show 11/12 tests passing note (implying a permanently failing test) was quietly dropped in the crc.md update.

Recommendations

  1. (Minor — same file, low risk) Update the DEV_MODE=true bullet in the crc.md Features section to avoid contradicting the corrected workflow text directly above it.
  2. (Minor — important for CRC users) Clarify or remove the "Need OpenShift-Specific Features?" guidance in local-development/README.md — pointing CRC users at make local-up (minikube) will not give them Routes or BuildConfigs.
  3. (Nice-to-have) Add a one-liner in the crc.md cleanup section explaining how to shut down the underlying cluster now that make dev-stop-cluster no longer exists.

Overall this is a clean, low-risk docs fix. Issues 1 and 2 are the only ones worth a follow-up before or after merge.


🔍 View AI decision process (logs available for 90 days)

📋 View memory system files loaded (click to expand)

What Amber Loaded for Code Review

Amber automatically loaded these repository standards from the memory system:

  1. CLAUDE.md - Master project instructions, development standards
  2. backend-development.md - Go backend, K8s integration patterns
  3. frontend-development.md - NextJS, Shadcn UI, React Query patterns
  4. security-standards.md - Auth, RBAC, token handling
  5. k8s-client-usage.md - User token vs service account patterns
  6. error-handling.md - Consistent error patterns
  7. react-query-usage.md - Data fetching patterns

Impact: This review used your repository's specific code quality standards, security patterns, and best practices from the memory system (PRs #359, #360) - not just generic code review guidelines.

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