Skip to content

Commit acbcdd3

Browse files
owineclaude
andcommitted
docs: refresh CLAUDE.md to reflect recent architectural changes
Update documentation to reflect: - Dockge workflow integration at workflow level - Removal of --has-dockge parameter from deployment scripts - Addition of deploy-dockge.sh script - Escaped parameter handling in health-check.sh - Updated script line counts and descriptions 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 2659fb0 commit acbcdd3

File tree

1 file changed

+26
-15
lines changed

1 file changed

+26
-15
lines changed

CLAUDE.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ This repository provides two main reusable workflows:
6666
6. **SSH Optimization**: Connection multiplexing and retry mechanisms
6767
7. **Parallel Execution**: All lint jobs (GitGuardian, YAML lint) run concurrently
6868
8. **Stack Removal Detection**: Automatic cleanup of removed stacks with fail-safe operation
69+
9. **Dockge Workflow Integration**: Dockge deployment handled at workflow level for cleaner separation of concerns
6970

7071
### Benefits of Centralization
7172

@@ -172,20 +173,37 @@ The deploy workflow uses modular bash scripts in `scripts/deployment/` for all m
172173
- Utility functions (`format_list`, `require_var`)
173174

174175
#### Deployment Scripts
175-
- **health-check.sh** - Service health verification (584 lines)
176-
- Stack-specific service counting with accurate compose file detection
177-
- Dynamic retry logic based on critical service failures
178-
- Comprehensive health status reporting (healthy/degraded/failed stacks)
179-
- Docker health status parsing (healthy/starting/unhealthy containers)
180-
- Dockge integration when enabled
181176

182-
- **deploy-stacks.sh** - Deployment orchestration (690 lines)
177+
- **deploy-dockge.sh** - Dockge container management deployment (110 lines)
178+
- Dedicated script for Dockge deployment operations
179+
- Called as separate workflow step before stack deployment
180+
- Configurable image pull and startup timeouts
181+
- Used for both initial deployment and rollback scenarios
182+
183+
- **deploy-stacks.sh** - Stack deployment orchestration (~425 lines)
183184
- Parallel stack deployment with background processes
184185
- Exit code file-based error detection
185186
- Comprehensive logging with stack-specific output
186187
- Git operations with configurable timeouts
187188
- Image pull and service startup with retry logic
188-
- Compose syntax and environment validation
189+
- Pre-deployment validation for all stacks
190+
- **Note**: No longer handles Dockge deployment (moved to workflow level)
191+
192+
- **rollback-stacks.sh** - Rollback automation (~425 lines)
193+
- SHA validation and git operations
194+
- Dynamic stack discovery from previous commit
195+
- Parallel rollback execution with PID tracking
196+
- Critical service failure detection
197+
- Comprehensive error reporting
198+
- **Note**: No longer handles Dockge rollback (moved to workflow level)
199+
200+
- **health-check.sh** - Service health verification (~590 lines)
201+
- Stack-specific service counting with accurate compose file detection
202+
- Dynamic retry logic based on critical service failures
203+
- Comprehensive health status reporting (healthy/degraded/failed stacks)
204+
- Docker health status parsing (healthy/starting/unhealthy containers)
205+
- Dockge health integration when enabled
206+
- Escaped parameter handling to prevent shell glob expansion
189207

190208
- **detect-removed-stacks.sh** - Stack removal detection (328 lines)
191209
- Three-method detection system (git diff, tree comparison, discovery analysis)
@@ -198,13 +216,6 @@ The deploy workflow uses modular bash scripts in `scripts/deployment/` for all m
198216
- 1Password integration for environment variables
199217
- Graceful handling of missing stacks
200218

201-
- **rollback-stacks.sh** - Rollback automation (495 lines)
202-
- SHA validation and git operations
203-
- Dynamic stack discovery from previous commit
204-
- Parallel rollback execution with PID tracking
205-
- Critical service failure detection
206-
- Comprehensive error reporting
207-
208219
#### Script Benefits
209220
- **Modularity**: Each script has a single, well-defined purpose
210221
- **Reusability**: Scripts can be called from other workflows or locally

0 commit comments

Comments
 (0)