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

ci: docker image always released as -dev #2358

Merged
merged 3 commits into from
Nov 29, 2024
Merged

Conversation

lklimek
Copy link
Contributor

@lklimek lklimek commented Nov 28, 2024

Issue being fixed or feature implemented

Due to some bug, docker images are always released as dev, not release

What was done?

Restored missing line

How Has This Been Tested?

GHA pipeline executed

Breaking Changes

None

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Summary by CodeRabbit

  • New Features
    • Introduced a new input parameter cargo_profile for specifying the Cargo build profile during Docker image builds.
    • Enhanced configurability of the Docker build process by allowing users to set the Cargo profile through action inputs.
    • Added a new input parameter cache_to_name for improved caching during Docker image builds when a release is triggered.
    • Updated the Dockerfile to allow specification of the build profile, enhancing the build process for the application.

Copy link
Contributor

coderabbitai bot commented Nov 28, 2024

Walkthrough

The pull request modifies the GitHub Actions workflows for building and pushing Docker images. It introduces a new input parameter, cargo_profile, for specifying the Cargo build profile (defaulting to dev), which is integrated into the Docker build step's build-args. Additionally, a new input parameter, cache_to_name, is added to the release workflow, enhancing the caching mechanism based on the event triggering the workflow. The overall structure and functionality of the actions remain unchanged, with no modifications to existing steps or outputs beyond these new inputs.

Changes

File Change Summary
.github/actions/docker/action.yaml - Added new input parameter cargo_profile with default value dev.
- Updated build-args to include CARGO_BUILD_PROFILE=${{ inputs.cargo_profile }}.
.github/workflows/release-docker-image.yml - Added new input parameter cache_to_name in the Build and push by digest step.
Dockerfile - Added ONBUILD ARG CARGO_BUILD_PROFILE=dev to allow specification of the build profile.

Possibly related PRs

  • ci: prebuilt librocksdb in docker image #2318: This PR modifies the same .github/actions/docker/action.yaml file, adding a new input parameter aws_region and updating the build-args, which is related to the changes made in the main PR regarding the addition of the cargo_profile input.
  • ci: improve caching #2329: This PR also modifies the .github/actions/docker/action.yaml file, introducing new inputs including cargo_profile and enhancing caching strategies, which directly relates to the changes in the main PR that added the cargo_profile input.
  • ci: change s3 cache provider to optimize costs #2344: This PR introduces a new action for managing AWS credentials and updates the Docker action inputs, which is relevant to the main PR's changes in the Docker workflow that involve new input parameters and caching strategies.
  • ci: switch release workflow to github runners #2346: This PR updates the workflow for building Docker images in .github/workflows/release-docker-image.yml, which is relevant as it involves Docker image management similar to the changes made in the main PR regarding Docker build configurations.

Suggested reviewers

  • QuantumExplorer
  • shumkov

Poem

🐇 In the land of code where rabbits play,
A new input shines bright, leading the way.
With cargo_profile set, oh what a delight,
Building with ease, everything feels right!
Hops of joy as we push and deploy,
Configurability now brings us such joy! 🌟

Warning

Rate limit exceeded

@lklimek has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 22 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between aecd869 and ed401d1.


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

@lklimek lklimek added this to the v1.6.0 milestone Nov 28, 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)
Dockerfile (1)

326-329: Consider adding a comment to document the profile usage.

The implementation correctly uses the build profile across all stages. Consider adding a brief comment explaining the impact of this argument on the build process.

 # Select whether we want dev or release
 ONBUILD ARG CARGO_BUILD_PROFILE=dev
+# CARGO_BUILD_PROFILE affects:
+# - Build configuration (debug/release)
+# - Output directory selection
+# - Feature flags (console,grovedbg in dev)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between aecd869 and ed401d1.

📒 Files selected for processing (1)
  • Dockerfile (1 hunks)
🔇 Additional comments (1)
Dockerfile (1)

326-329: LGTM! The ONBUILD ARG implementation looks good.

The implementation correctly allows for dynamic selection of the Cargo build profile, defaulting to 'dev'. This change enables proper tagging of Docker images based on the build profile.

Let's verify the profile usage in build stages:

✅ Verification successful

The CARGO_BUILD_PROFILE implementation is correctly used throughout the build process

The verification confirms that:

  • The profile is consistently used in cargo build commands with --profile "${CARGO_BUILD_PROFILE}"
  • Proper conditional logic handles release vs dev profiles:
    • Release mode: Uses config-release.toml and sets appropriate output directory
    • Dev mode: Adds debug features (console, grovedbg)
  • The profile setting propagates to the wasm-dpp build script with correct profile mapping
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that CARGO_BUILD_PROFILE is used consistently across build stages

# Check for profile usage in build commands
rg -A 3 'CARGO_BUILD_PROFILE|cargo (build|chef).*--profile' 

# Check for conditional logic based on profile
rg -A 3 '\[\[ .*CARGO_BUILD_PROFILE.* \]\]'

Length of output: 2725

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