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: rocksdb version in makefile #21654

Merged
merged 3 commits into from
Sep 11, 2024
Merged

ci: rocksdb version in makefile #21654

merged 3 commits into from
Sep 11, 2024

Conversation

auricom
Copy link
Contributor

@auricom auricom commented Sep 11, 2024

Description

Rocksdb version is now defined in makefile for easier maintenance.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Introduced dynamic retrieval of the RocksDB version during build, lint, and test processes, enhancing flexibility and ensuring up-to-date versioning.
    • Added a specific version reference for RocksDB in the build configuration.
  • Bug Fixes

    • Improved error handling in workflows to ensure graceful failure if the RocksDB version is not found.
  • Chores

    • Removed hardcoded RocksDB version references from workflow configurations.

@auricom auricom requested a review from a team as a code owner September 11, 2024 11:15
Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

Walkthrough

This pull request introduces modifications to the installation and workflow scripts for RocksDB. It removes the hardcoded ROCKSDB_VERSION environment variable from GitHub Actions workflows and adds a mechanism to dynamically retrieve the version from a Makefile. A new script, get-rocksdb-version.sh, is introduced to facilitate this retrieval process. Additionally, a minor change is made to the install-rocksdb.sh script regarding the git checkout command syntax, and a new variable rocksdb_version is defined in the Makefile.

Changes

Files Change Summary
.github/scripts/get-rocksdb-version.sh, .github/scripts/install-rocksdb.sh Added a new script to retrieve RocksDB version and made a minor modification to the git checkout command syntax.
.github/workflows/build.yml, .github/workflows/lint.yml, .github/workflows/test.yml Removed static ROCKSDB_VERSION and added dynamic retrieval of version from ./scripts/build/build.mk.
scripts/build/build.mk Added new variable rocksdb_version=v8.11.3 to define the version of RocksDB.

Possibly related PRs

Suggested labels

Type: Build


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 071aa50 and 586565b.

Files selected for processing (5)
  • .github/scripts/install-rocksdb.sh (1 hunks)
  • .github/workflows/build.yml (2 hunks)
  • .github/workflows/lint.yml (2 hunks)
  • .github/workflows/test.yml (2 hunks)
  • scripts/build/build.mk (1 hunks)
Files skipped from review due to trivial changes (2)
  • .github/scripts/install-rocksdb.sh
  • scripts/build/build.mk
Additional context used
actionlint
.github/workflows/build.yml

29-29: shellcheck reported issue in this script: SC2086:info:8:48: Double quote to prevent globbing and word splitting

(shellcheck)

.github/workflows/lint.yml

31-31: shellcheck reported issue in this script: SC2086:info:8:48: Double quote to prevent globbing and word splitting

(shellcheck)

.github/workflows/test.yml

792-792: shellcheck reported issue in this script: SC2086:info:8:48: Double quote to prevent globbing and word splitting

(shellcheck)

Additional comments not posted (2)
.github/workflows/lint.yml (2)

30-40: LGTM! The code segment improves the workflow.

Dynamically retrieving the RocksDB version from the Makefile enhances the flexibility and maintainability of the workflow.

Tools
actionlint

31-31: shellcheck reported issue in this script: SC2086:info:8:48: Double quote to prevent globbing and word splitting

(shellcheck)


31-31: Address the shellcheck issue by double quoting the variable.

The static analysis tool shellcheck suggests double quoting the $rocksdb_version variable to prevent globbing and word splitting.

Apply this diff to fix the issue:

-          echo "ROCKSDB_VERSION=$rocksdb_version" >> $GITHUB_ENV
+          echo "ROCKSDB_VERSION=\"$rocksdb_version\"" >> $GITHUB_ENV

Likely invalid or redundant comment.

Tools
actionlint

31-31: shellcheck reported issue in this script: SC2086:info:8:48: Double quote to prevent globbing and word splitting

(shellcheck)

.github/workflows/build.yml Outdated Show resolved Hide resolved
.github/workflows/test.yml Outdated Show resolved Hide resolved
@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 11, 2024
@auricom auricom added this pull request to the merge queue Sep 11, 2024
Merged via the queue into main with commit aa8bf41 Sep 11, 2024
67 checks passed
@auricom auricom deleted the claude/rocksdb_version branch September 11, 2024 12:42
mergify bot pushed a commit that referenced this pull request Sep 11, 2024
(cherry picked from commit aa8bf41)

# Conflicts:
#	.github/workflows/build.yml
#	.github/workflows/lint.yml
#	.github/workflows/test.yml
julienrbrt added a commit that referenced this pull request Sep 11, 2024
Co-authored-by: auricom <27022259+auricom@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release Type: CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants