Skip to content
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

chore(build): move common functions to longhorn/dep-versions #456

Merged
merged 1 commit into from
Feb 12, 2025

Conversation

derekbit
Copy link
Member

Which issue(s) this PR fixes:

Issue longhorn/longhorn#10208

What this PR does / why we need it:

Special notes for your reviewer:

Additional documentation or context

@derekbit derekbit requested a review from c3y1huang February 11, 2025 09:57
@derekbit derekbit self-assigned this Feb 11, 2025
Copy link

coderabbitai bot commented Feb 11, 2025

Walkthrough

This pull request introduces two new build arguments, SRC_BRANCH and SRC_TAG, into the Docker build process. In the Dockerfile, these arguments are set up with defaults and then passed as environment variables. The Makefile is updated to export these variables by dynamically retrieving the current branch and Git tag. Additionally, two functions (convert_version_to_major_minor_x and get_branch) are removed from the scripts, which alters how version and branch information is processed during packaging.

Changes

Files Change Summary
Dockerfile.dapper, Makefile Introduced new build arguments/variables: SRC_BRANCH (defaulting to main) and SRC_TAG; updated environment variable export and dynamic retrieval in Makefile.
scripts/package Removed two functions (convert_version_to_major_minor_x and get_branch), eliminating the previous logic for version conversion and branch determination.

Sequence Diagram(s)

sequenceDiagram
    participant M as Makefile
    participant S as Shell
    participant D as Docker Build
    M->>S: Execute command to fetch current branch and tag
    S-->>M: Return current branch and latest Git tag
    M->>D: Initiate docker build with SRC_BRANCH and SRC_TAG as build args
    D->>D: Set ENV variables (SRC_BRANCH, SRC_TAG) from build args
Loading

Assessment against linked issues

Objective Addressed Explanation
Update dependent package version retrieval from longhorn/dep-versions (#10208) No modifications to package/Dockerfile were made to retrieve version and repo info from dep-versions.

Possibly related PRs

Suggested reviewers

  • COLDTURNIP
  • innobead
  • c3y1huang

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

@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: 2

🔭 Outside diff range comments (1)
scripts/package (1)

32-39: 💡 Verification agent

🧩 Analysis chain

Verify SRC_BRANCH and SRC_TAG are properly set.

The script uses SRC_BRANCH and SRC_TAG in the build command, but these variables are not defined within the script. Ensure these variables are properly set before use to avoid empty values in the build process.

Run this script to check if the variables are properly set:


🏁 Script executed:

#!/bin/bash
# Description: Check if SRC_BRANCH and SRC_TAG are properly set in the build environment

# Test: Check if variables are set in the environment
echo "Checking environment variables..."
env | grep -E "^(SRC_BRANCH|SRC_TAG)="

# Test: Check if variables are set in the Makefile
echo -e "\nChecking Makefile exports..."
make -n | grep -E "export (SRC_BRANCH|SRC_TAG)"

Length of output: 336


Action Required: Define Environment Variables SRC_BRANCH and SRC_TAG

  • The environment check didn’t return any values for SRC_BRANCH and SRC_TAG, meaning they are not set.
  • Additionally, the attempt to inspect Makefile exports was inconclusive due to the "make" command not being available.

Please ensure that these variables are explicitly defined (or have default values) before invoking the build command to avoid potential issues during the build process.

🧹 Nitpick comments (1)
Dockerfile.dapper (1)

4-5: Consider adding SRC_BRANCH and SRC_TAG to DAPPER_ENV.

The new environment variables SRC_BRANCH and SRC_TAG should be added to DAPPER_ENV to ensure they are properly passed through to the dapper environment.

Apply this diff to update DAPPER_ENV:

-ENV DAPPER_ENV TAG REPO DRONE_REPO DRONE_PULL_REQUEST DRONE_COMMIT_REF
+ENV DAPPER_ENV TAG REPO DRONE_REPO DRONE_PULL_REQUEST DRONE_COMMIT_REF SRC_BRANCH SRC_TAG

Also applies to: 16-17

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 261ae97 and 1cc9dbf.

📒 Files selected for processing (3)
  • Dockerfile.dapper (2 hunks)
  • Makefile (1 hunks)
  • scripts/package (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Build binaries
  • GitHub Check: Summary

@derekbit derekbit merged commit 742209d into longhorn:master Feb 12, 2025
9 checks passed
@derekbit
Copy link
Member Author

@mergify backport v1.8.x

Copy link

mergify bot commented Feb 18, 2025

backport v1.8.x

✅ Backports have been created

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.

2 participants