Simplify Installation for v1.0.1 by Bundling Dependencies in Repository #234
Conversation
This file contains 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
Simplify Installation for v1.0.1 by Bundling Dependencies in Repository
🚨 Report Summary
For more details view the full report in OpenZeppelin Code Inspector |
|
hey @mikelxc Thank you for submitting this PR. I have a couple of questions before merging
|
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 enhances the installation process for the smart contract by bundling all necessary dependencies directly within the repository. This change addresses the current requirement of reading dependencies from node_modules, which necessitates an extra installation step. This also enables direct import of the contracts via
soldeer install nexus~1.0.2Changes Made
• Bundled Dependencies: Moved all required dependencies into a dedicated deps folder within the repository.
• Minimal Modifications: Ensured that changes are minimal and only apply to the v1.0.1 release to maintain compatibility with existing setups.
• Deployment: Deployed the updated contract to the Soldeer Package Manager for seamless access.
Benefits
• Streamlined Installation: Eliminates the need for users to manually install dependencies from node_modules, reducing setup complexity.
• Enhanced Stability: By controlling the dependency versions within the repository, we ensure consistent behavior across different environments.
• Quick Access: Users can easily access the contract through the Soldeer Package Manager without additional configuration steps.
Deployment Details
• Package Manager: Soldeer
• Project Link: https://soldeer.xyz/project/nexus
Notes
• Release Specific: These changes are exclusively for the v1.0.1 release and do not impact other versions.
• Future Releases: Consider adopting a dependency management strategy that minimizes repository size and enhances scalability for future releases.
Please review the changes and provide feedback or approval. Thank you!