Skip to content

Conversation

@tchow-zlai
Copy link
Collaborator

@tchow-zlai tchow-zlai commented Dec 3, 2024

Summary

Checklist

  • Added Unit Tests
  • Covered by existing CI
  • Integration tested
  • Documentation update

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.

@tchow-zlai tchow-zlai requested review from nikhil-zlai and piyush-zlai and removed request for piyush-zlai December 3, 2024 19:25
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Walkthrough

This pull request introduces two new configuration files: .plugin-versions and .tool-versions, which manage plugin versions and tool versions respectively for the project. Additionally, the build.sbt file is updated to specify explicit versions for various dependencies, enhancing clarity and consistency in dependency management. The devnotes.md file is also revised to provide clearer setup instructions for the Chronon project, particularly regarding the asdf version manager and the installation of specific runtimes.

Changes

File Change Summary
.plugin-versions New file added specifying plugins (asdf-plugin-manager, java, python, sbt, scala) with URLs and commit hashes.
.tool-versions New file added defining versions for Java, Scala, Asdf Plugin Manager, SBT, and Python.
build.sbt Updates include explicit dependency versions for circe-parser, addition of new dependencies for spark and cloud_gcp, and enhancements to the frontend project settings.
devnotes.md Enhanced setup instructions for the Chronon project, detailing the use of asdf, installation steps, and build processes.

Possibly related PRs

  • chore: update devnotes #97: The changes in devnotes.md include updates related to the asdf version manager, which is also referenced in the main PR's introduction of the .plugin-versions file for managing plugins.

Suggested reviewers

  • nikhil-zlai
  • piyush-zlai
  • chewy-zlai
  • varant-zlai

🐇 In the land of code where rabbits play,
New versions hop in, brightening the day!
With plugins and tools, all set to align,
Our project now sparkles, oh how it will shine!
So gather your carrots, let’s code with delight,
For every new change makes our future so bright! 🌟


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@tchow-zlai tchow-zlai changed the title Tchow/asdf tool versions asdf to install runtime versions for chronon Dec 3, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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:

  1. Why these specific versions are required for OSS distribution
  2. How these versions differ from the ones in .tool-versions
  3. 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

📥 Commits

Reviewing files that changed from the base of the PR and between 42780a4 and dc01ec1.

📒 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:

  1. Installation of ASDF
  2. Addition of plugin manager
  3. Installation of plugin manager
  4. Addition and update of all required plugins
  5. 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
Copy link
Contributor

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

Copy link
Collaborator Author

@tchow-zlai tchow-zlai Dec 3, 2024

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.

Copy link
Contributor

@nikhil-zlai nikhil-zlai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very cool

@tchow-zlai tchow-zlai merged commit cb0309e into main Dec 4, 2024
7 checks passed
@tchow-zlai tchow-zlai deleted the tchow/asdf-tool-versions branch December 4, 2024 19:04
chewy-zlai pushed a commit that referenced this pull request Dec 4, 2024
## 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 -->
@coderabbitai coderabbitai bot mentioned this pull request Feb 17, 2025
4 tasks
@coderabbitai coderabbitai bot mentioned this pull request Mar 11, 2025
4 tasks
kumar-zlai pushed a commit that referenced this pull request Apr 25, 2025
## 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 -->
kumar-zlai pushed a commit that referenced this pull request Apr 29, 2025
## 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 -->
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
## 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 -->
chewy-zlai pushed a commit that referenced this pull request May 16, 2025
## 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 -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants