Skip to content

Conversation

@david-zlai
Copy link
Contributor

@david-zlai david-zlai commented Mar 13, 2025

…aths.

Summary

Checklist

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

Summary by CodeRabbit

  • Chores

    • Updated cloud artifact upload paths for improved organization and release consistency.
  • Bug Fixes

    • Corrected directory naming errors in quickstart scripts to ensure smooth deployment operations.
    • Fixed spelling errors in directory names for consistency across scripts.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 13, 2025

Walkthrough

This update restructures the S3 bucket paths used by the artifact upload and quickstart scripts. The build script now employs a new directory for wheels and adjusts the path for JAR files, removing an outdated wheel upload step. Both AWS and GCP quickstart scripts correct a directory naming typo ("cananry-confs" → "canary-confs") and update S3 paths where applicable. No changes were made to public interfaces.

Changes

File(s) Changed Change Summary
scripts/distribution/build_and_upload_artifacts.sh Modified S3 paths for JARs (.../release/latest/jars/); introduced ELEMENT_WHEEL_PATH for wheels (.../release/latest/wheels/); removed old wheel upload command.
scripts/distribution/run_aws_quickstart.sh and scripts/distribution/run_gcp_quickstart.sh Corrected directory typo from cananry-confs to canary-confs; in AWS script, updated the S3 path for downloading the wheel file to the new wheels directory.

Sequence Diagram(s)

sequenceDiagram
    participant BS as Build Script
    participant S3 as AWS S3
    BS->>S3: Upload JAR files to .../release/latest/jars/
    BS->>S3: Upload wheel file via ELEMENT_WHEEL_PATH to .../release/latest/wheels/
Loading
sequenceDiagram
    participant AWSQS as AWS Quickstart Script
    participant Repo as GitHub Repository
    participant S3 as AWS S3
    AWSQS->>Repo: Clone canary-confs repository
    AWSQS->>S3: Download wheel from .../release/latest/wheels/ path
Loading

Possibly related PRs

Suggested reviewers

  • chewy-zlai
  • tchow-zlai

Poem

Artifacts now take flight in clouded skies,
With paths aligned where order lies.
Canaries chirp in corrected tone,
Wheels and JARs in their new home.
Code ascends with a joyful glow.
🚀✨

Warning

Review ran into problems

🔥 Problems

GitHub Actions and Pipeline Checks: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.


🪧 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.

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

🧹 Nitpick comments (6)
scripts/distribution/run_gcp_quickstart.sh (2)

8-8: Fix dir removal spelling.
Changed from "cananry-confs" to "canary-confs".


21-23: Correct clone & CD.
Repo URL and directory now use "canary-confs". Add || exit to cd for safety.

🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 23-23: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)

scripts/distribution/run_aws_quickstart.sh (3)

20-20: Fix dir removal spelling.
Corrected to "canary-confs".


36-38: Correct clone & CD.
Now clones "canary-confs". Consider cd canary-confs || exit to handle failures.

🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 38-38: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)


49-49: Update S3 wheel path.
New path: s3://zipline-artifacts-canary/release/latest/wheels/$WHEEL_FILE.

scripts/distribution/build_and_upload_artifacts.sh (1)

214-219: Update S3 upload paths.
Using /release/latest/jars/ for jars and /release/latest/wheels/ for wheels.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 85306d9 and 7b70114.

📒 Files selected for processing (3)
  • scripts/distribution/build_and_upload_artifacts.sh (1 hunks)
  • scripts/distribution/run_aws_quickstart.sh (3 hunks)
  • scripts/distribution/run_gcp_quickstart.sh (2 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
scripts/distribution/run_gcp_quickstart.sh

[warning] 23-23: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)

scripts/distribution/run_aws_quickstart.sh

[warning] 38-38: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)

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

🧹 Nitpick comments (1)
scripts/distribution/run_aws_quickstart.sh (1)

38-38: Add cd error handling.
Use "cd canary-confs || exit" to handle potential failures.

🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 38-38: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 7b70114 and 4908688.

📒 Files selected for processing (1)
  • scripts/distribution/run_aws_quickstart.sh (3 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
scripts/distribution/run_aws_quickstart.sh

[warning] 38-38: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)

🔇 Additional comments (4)
scripts/distribution/run_aws_quickstart.sh (4)

20-20: Fix directory removal name.
Corrected "cananry-confs" to "canary-confs".


34-34: Set wheel filename.
Assigns the updated wheel file name.


37-37: Fix git clone URL.
Updated repo URL to use the correctly spelled "canary-confs".


49-49: Update S3 wheel path.
New S3 path reflects the updated release structure.

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

🧹 Nitpick comments (1)
scripts/distribution/run_aws_quickstart.sh (1)

42-42: Shellcheck Suggestion: Add error handling to cd canary-confs to avoid directory change failure. For example:

- cd canary-confs
+ cd canary-confs || exit 1
🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 42-42: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 4908688 and 3087951.

📒 Files selected for processing (1)
  • scripts/distribution/run_aws_quickstart.sh (3 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
scripts/distribution/run_aws_quickstart.sh

[warning] 42-42: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)

🔇 Additional comments (5)
scripts/distribution/run_aws_quickstart.sh (5)

20-20: Typo Fixed: Corrected removal command from "cananry-confs" to "canary-confs".


38-38: Wheel Variable Updated: New wheel file version is defined.


40-40: Comment Clarification: The comment now correctly refers to canary configs.


41-41: Clone URL Corrected: Updated the repository URL from cananry to canary.


57-57: S3 Path Updated: The S3 command now correctly points to the new release wheels directory.

@david-zlai david-zlai merged commit 32ef263 into main Mar 13, 2025
4 checks passed
@david-zlai david-zlai deleted the davidhan/not_cananry branch March 13, 2025 18:03
kumar-zlai pushed a commit that referenced this pull request Apr 25, 2025
…aths (#502)

…aths.

## Summary

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [x] Integration tested
- [ ] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Chores**
- Updated cloud artifact upload paths for improved organization and
release consistency.
  
- **Bug Fixes**
- Corrected directory naming errors in quickstart scripts to ensure
smooth deployment operations.
- Fixed spelling errors in directory names for consistency across
scripts.
<!-- 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.

3 participants