-
Notifications
You must be signed in to change notification settings - Fork 17.3k
Update README. #497
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Update README. #497
Conversation
WalkthroughThe README instructions for setting up the SonarQube server have been updated to use the Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
java-maven-sonar-argocd-helm-k8s/spring-boot-app/README.md (1)
64-66: Hard-coded absolute path – prefer$SONARQUBE_HOMENow that you place SonarQube in the user’s home, referencing
/home/sonarqube/sonarqubeeverywhere couples the docs to that exact layout.
Defining and using an env-var upfront keeps the guide version-agnostic and easier to tweak:export SONARQUBE_HOME=/home/sonarqube/sonarqube chown -R sonarqube:sonarqube "$SONARQUBE_HOME" chmod -R 775 "$SONARQUBE_HOME" cd "$SONARQUBE_HOME/bin/linux-x86-64"This also plays nicely with future upgrades where the extracted folder includes the version in its name.
| adduser sonarqube | ||
| wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-10.4.1.88267.zip | ||
| unzip * | ||
| chown -R sonarqube:sonarqube /opt/sonarqube | ||
| chmod -R 775 /opt/sonarqube | ||
| cd /opt/sonarqube/bin/linux-x86-64 | ||
| chown -R sonarqube:sonarqube /home/sonarqube/sonarqube | ||
| chmod -R 775 /home/sonarqube/sonarqube | ||
| cd /home/sonarqube/sonarqube/bin/linux-x86-64 | ||
| ./sonar.sh start | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extraction folder not created → subsequent chown, chmod, and cd will fail
unzip * extracts into sonarqube-10.4.1.88267/ (or whatever versioned dir), not /home/sonarqube/sonarqube.
Therefore the three commands that follow reference a non-existent path and will error.
-wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-10.4.1.88267.zip
-unzip *
-chown -R sonarqube:sonarqube /home/sonarqube/sonarqube
-chmod -R 775 /home/sonarqube/sonarqube
-cd /home/sonarqube/sonarqube/bin/linux-x86-64
+wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-10.4.1.88267.zip
+unzip sonarqube-10.4.1.88267.zip
+mv sonarqube-10.4.1.88267 /home/sonarqube/sonarqube
+chown -R sonarqube:sonarqube /home/sonarqube/sonarqube
+chmod -R 775 /home/sonarqube/sonarqube
+cd /home/sonarqube/sonarqube/bin/linux-x86-64Alternatively, keep the versioned directory and adjust the subsequent paths.
Without this fix, newcomers following the README will hit No such file or directory.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| adduser sonarqube | |
| wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-10.4.1.88267.zip | |
| unzip * | |
| chown -R sonarqube:sonarqube /opt/sonarqube | |
| chmod -R 775 /opt/sonarqube | |
| cd /opt/sonarqube/bin/linux-x86-64 | |
| chown -R sonarqube:sonarqube /home/sonarqube/sonarqube | |
| chmod -R 775 /home/sonarqube/sonarqube | |
| cd /home/sonarqube/sonarqube/bin/linux-x86-64 | |
| ./sonar.sh start | |
| ``` | |
| adduser sonarqube | |
| wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-10.4.1.88267.zip | |
| unzip sonarqube-10.4.1.88267.zip | |
| mv sonarqube-10.4.1.88267 /home/sonarqube/sonarqube | |
| chown -R sonarqube:sonarqube /home/sonarqube/sonarqube | |
| chmod -R 775 /home/sonarqube/sonarqube | |
| cd /home/sonarqube/sonarqube/bin/linux-x86-64 | |
| ./sonar.sh start |
🤖 Prompt for AI Agents
In java-maven-sonar-argocd-helm-k8s/spring-boot-app/README.md around lines 61 to
68, the unzip command extracts files into a versioned directory (e.g.,
sonarqube-10.4.1.88267/) rather than /home/sonarqube/sonarqube, causing the
following chown, chmod, and cd commands to fail due to incorrect paths. Fix this
by either extracting directly into /home/sonarqube/sonarqube or updating the
chown, chmod, and cd commands to use the actual extracted versioned directory
path.
i am changing path of sonarqube to the sonarqube home directory instead of opt directory
Summary by CodeRabbit