This repository was archived by the owner on Oct 10, 2025. It is now read-only.
feat: [#24] Improve UX by adding automatic waiting to deployment commands #25
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add documentation for intelligent sudo cache management functions - Document ensure_sudo_cached(), is_sudo_cached(), run_with_sudo() functions - Explain automatic prompting and cache preparation to improve UX - Add testing information for sudo cache functionality - Update contributor guidelines for infrastructure operations
…ands Add intelligent waiting logic to prevent premature command execution: Infrastructure improvements: - Add wait_for_vm_ip() and wait_for_cloud_init_completion() to shell-utils.sh - Enhance provision-infrastructure.sh with automatic VM readiness waiting - Fix tofu output command working directory issue causing warning messages - Add SKIP_WAIT parameter support for advanced users who want faster execution Application improvements: - Enhance deploy-app.sh with conditional service health waiting - Improve deployment logging and progress feedback - Maintain existing wait_for_services functionality with better UX Makefile integration: - Add SKIP_WAIT parameter support to infra-apply and app-deploy targets - Provide user-friendly messaging about waiting behavior - Enable advanced users to bypass waiting with SKIP_WAIT=true Testing updates: - Update E2E tests to use centralized waiting functions - Ensure tests validate both default waiting and skip-wait scenarios - Maintain comprehensive test coverage for improved workflow User experience impact: - Eliminates manual waiting between make infra-apply → make app-deploy → make app-health-check - Provides clear progress feedback during deployment operations - Preserves advanced user workflow with optional skip functionality - Fixes confusing output messages caused by working directory bug This resolves the poor UX where deployment commands would fail if run too quickly, implementing Solution 1 from the GitHub issue analysis.
|
ACK ad974e0 |
josecelano
added
Code Cleanup / Refactoring
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR resolves issue #24 by implementing automatic waiting logic in deployment commands to prevent premature execution failures and improve user experience.
Problem Solved
Previously, the three-step deployment workflow would fail if commands were run too quickly:
Users had to manually wait and guess timing, leading to poor UX and unreliable deployments.
Solution Implemented
Solution 1: Default automatic waiting with
SKIP_WAIToption for advanced users.Key Features
make infra-applymake app-deploySKIP_WAIT=true)Changes Made
Infrastructure Layer
wait_for_vm_ip()andwait_for_cloud_init_completion()functionsUser Interface
SKIP_WAITparameter support forinfra-applyandapp-deployTesting & Quality
Testing Results
✅ Manual Testing
✅ E2E Testing
✅ Advanced User Workflow
Impact
🎯 User Experience
🏗️ Technical Benefits
Documentation
Updated documentation includes:
Breaking Changes
None - This is a pure UX improvement that maintains backward compatibility.
Related Issues
Review Notes
The three-step deployment workflow now works seamlessly without manual intervention, while preserving advanced user capabilities.