Improve installation: Use /usr/local/bin & simplify manual install#21
Open
shv-ng wants to merge 4 commits intoorhnk:masterfrom
Open
Improve installation: Use /usr/local/bin & simplify manual install#21shv-ng wants to merge 4 commits intoorhnk:masterfrom
shv-ng wants to merge 4 commits intoorhnk:masterfrom
Conversation
Reviewer's Guide by SourceryThis pull request improves the installation process by changing the installation path to Sequence diagram for the new installation processsequenceDiagram
actor User
participant Shell
participant GitHub
participant System
User->>Shell: Run install command
Shell->>GitHub: curl installation script
GitHub-->>Shell: Return install.sh
Shell->>Shell: Execute install.sh
Shell->>GitHub: git clone RASCII
GitHub-->>Shell: Return repository
Shell->>Shell: Build with cargo
Shell->>System: Copy binary to /usr/local/bin
System-->>User: Installation complete
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @ShivangSrivastava - I've reviewed your changes - here's some feedback:
Overall Comments:
- Using
curl | shfor installation is a security risk - users should be encouraged to download and inspect the installation script before running it. Consider providing the manual installation steps alongside a downloadable script. - The installation script assumes the RASCII directory doesn't exist and could fail if it does. Please add appropriate error checking and directory handling.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Owner
|
Thanks for the PR. Could you implement the suggested improvements please? |
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
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.
Description:
This PR improves the installation process by:
Using
/usr/local/bininstead of/usr/bin/usr/local/binis the recommended location for user-installed binaries.Simplifying manual installation in the README
chmod +x, users can now install with a single command:curl -sL https://raw.githubusercontent.com/orhnk/RASCII/refs/heads/master/install.sh | shThese changes follow best practices and improve the user experience.
Summary by Sourcery
Update the installation script to install the binary to
/usr/local/bininstead of/usr/bin. Simplify the manual installation instructions in the README to a single command.Enhancements:
/usr/local/binfor binary installation, which is the standard location for user-installed executables and prevents conflicts with system packages.curlcommand that clones the repository, builds the binary, and installs it.