-
Notifications
You must be signed in to change notification settings - Fork 8
asdf to install runtime versions for chronon #106
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
Conversation
WalkthroughThis pull request introduces two new configuration files: Changes
Possibly related PRs
Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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: 0
🧹 Outside diff range and nitpick comments (1)
devnotes.md (1)
41-42: Consider clarifying the OSS distribution note.While the note about using specific Scala and Java versions for the OSS Chronon distribution is important, it could be more helpful with additional context.
Consider expanding the note to explain:
- Why these specific versions are required for OSS distribution
- How these versions differ from the ones in
.tool-versions- When developers should use these versions vs. the ones in
.tool-versions-> NOTE: Use scala `2.12.18` and java `corretto-8` for the OSS Chronon distribution. +> NOTE: For the Open Source Software (OSS) Chronon distribution: +> - Use scala `2.12.18` and java `corretto-8` +> - These versions ensure compatibility with the OSS ecosystem +> - For regular development, use the versions specified in `.tool-versions`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
.plugin-versions(1 hunks).tool-versions(1 hunks)build.sbt(1 hunks)devnotes.md(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- .plugin-versions
- .tool-versions
🔇 Additional comments (2)
build.sbt (1)
92-92: Verify the necessity of adding circe-parser dependency.
The addition of circe-parser seems unrelated to the PR's main objective of implementing ASDF tool versions. Please clarify if this is an intentional change or if it should be part of a separate PR.
devnotes.md (1)
34-39: LGTM! Clear and comprehensive ASDF setup instructions.
The instructions for setting up ASDF are well-structured and include all necessary steps:
- Installation of ASDF
- Addition of plugin manager
- Installation of plugin manager
- Addition and update of all required plugins
- Installation of required runtimes
| java https://github.com/halcyon/asdf-java.git 0ec69b2 | ||
| python https://github.com/danhper/asdf-python.git a3a0185 | ||
| sbt https://github.com/lerencao/asdf-sbt 53c9f4b | ||
| scala https://github.com/asdf-community/asdf-scala.git 0533444 |
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.
is there a asdf thrift? will be nice to pin it to 0.21 if there is
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.
there is - although it's requires some additional installations that aren't available through asdf. I'll put up a separate PR to illustrate how to install thrift.
nikhil-zlai
left a comment
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.
very cool
## Summary - Similar to the setup in zipline-ai/infrastructure#3, single tool to install the full set of runtime versions. ## Checklist - [ ] Added Unit Tests - [ ] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced `.plugin-versions` and `.tool-versions` files for managing plugin and tool versions, ensuring consistent development environments. - **Documentation** - Updated `devnotes.md` with detailed setup instructions for the Chronon project, including installation of the `asdf` version manager and enhanced troubleshooting steps. - **Bug Fixes** - Clarified installation instructions for Thrift versions to address compatibility issues. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
## Summary - Similar to the setup in zipline-ai/infrastructure#3, single tool to install the full set of runtime versions. ## Checklist - [ ] Added Unit Tests - [ ] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced `.plugin-versions` and `.tool-versions` files for managing plugin and tool versions, ensuring consistent development environments. - **Documentation** - Updated `devnotes.md` with detailed setup instructions for the Chronon project, including installation of the `asdf` version manager and enhanced troubleshooting steps. - **Bug Fixes** - Clarified installation instructions for Thrift versions to address compatibility issues. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
## Summary - Similar to the setup in zipline-ai/infrastructure#3, single tool to install the full set of runtime versions. ## Checklist - [ ] Added Unit Tests - [ ] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced `.plugin-versions` and `.tool-versions` files for managing plugin and tool versions, ensuring consistent development environments. - **Documentation** - Updated `devnotes.md` with detailed setup instructions for the Chronon project, including installation of the `asdf` version manager and enhanced troubleshooting steps. - **Bug Fixes** - Clarified installation instructions for Thrift versions to address compatibility issues. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
## Summary - Similar to the setup in zipline-ai/infrastructure#3, single tool to install the full set of runtime versions. ## Checklist - [ ] Added Unit Tests - [ ] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced `.plugin-versions` and `.tool-versions` files for managing plugin and tool versions, ensuring consistent development environments. - **Documentation** - Updated `devnotes.md` with detailed setup instructions for the Chronon project, including installation of the `asdf` version manager and enhanced troubleshooting steps. - **Bug Fixes** - Clarified installation instructions for Thrift versions to address compatibility issues. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
## Summary - Similar to the setup in zipline-ai/infrastructure#3, single tool to install the full set of runtime versions. ## Cheour clientslist - [ ] Added Unit Tests - [ ] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced `.plugin-versions` and `.tool-versions` files for managing plugin and tool versions, ensuring consistent development environments. - **Documentation** - Updated `devnotes.md` with detailed setup instructions for the Chronon project, including installation of the `asdf` version manager and enhanced troubleshooting steps. - **Bug Fixes** - Clarified installation instructions for Thrift versions to address compatibility issues. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Summary
Checklist
Summary by CodeRabbit
.plugin-versionsand.tool-versionsfiles for managing plugin and tool versions, ensuring consistent development environments.devnotes.mdwith detailed setup instructions for the Chronon project, including installation of theasdfversion manager and enhanced troubleshooting steps.