feat: added port checker warning for local setup #8
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces a port management system to ensure required and optional ports are available before setting up Docker services or SonarQube. It includes new Makefile commands, scripts for port checking, and updates to documentation to guide developers on resolving port conflicts. The changes aim to improve the reliability of local development and SonarQube setup processes.
Port Management Enhancements:
check-portsandcheck-sonarqube-portscommands to the Makefile, which are automatically invoked duringlocal-setupandsonarqube-setupto ensure required ports are available. Standalone commandscheck-ports-standaloneandcheck-sonarqube-ports-standalonewere also added for manual checks. [1] [2] [3] [4]containers/check-ports.shscript to verify availability of required ports (e.g.,8081,3306) and suggest alternatives if conflicts are detected.containers/check-sonarqube-ports.shscript specifically for SonarQube-related ports (9000,5432), with tailored suggestions for resolving conflicts.Documentation Updates:
containers/README.mdto document new port management commands, required and optional ports, and instructions for resolving conflicts. This includes a new "Port Conflict Prevention" section. [1] [2] [3]These changes collectively improve the developer experience by proactively identifying and addressing port conflicts, reducing setup errors, and providing clear guidance for resolution.