From 14b6a8d6d86be135b54b881a8c69b203129f4a10 Mon Sep 17 00:00:00 2001 From: Yingchun Lai Date: Wed, 15 Nov 2023 15:31:20 +0800 Subject: [PATCH] Update readme to use the main branch of facebook/rocksdb (#5) Because there are some patches only pushed to the `main` branch of facebook/rocksdb, but not on the branch `v8.5.3`, the patches are plugin unit tests related, the unit tests will not act as expected without these patches. So it would be better to use the `main` branch in README.md The patches are: https://github.com/facebook/rocksdb/commit/76402c034e8fa75809df3ed89a5742f044e980e9 https://github.com/facebook/rocksdb/commit/c4c62c230438b06bae67189baaa5a7661e590160 --- .github/actions/pre-steps-macos/action.yml | 2 +- .github/actions/pre-steps/action.yml | 2 +- .github/workflows/sanity_check.yml | 2 +- README.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/actions/pre-steps-macos/action.yml b/.github/actions/pre-steps-macos/action.yml index ab4ed4b..a6290d5 100644 --- a/.github/actions/pre-steps-macos/action.yml +++ b/.github/actions/pre-steps-macos/action.yml @@ -4,7 +4,7 @@ runs: steps: - name: Clone rocksdb run: | - git clone --depth 1 --branch v8.5.3 https://github.com/facebook/rocksdb.git + git clone --depth 1 https://github.com/facebook/rocksdb.git shell: bash - uses: actions/checkout@v4 with: diff --git a/.github/actions/pre-steps/action.yml b/.github/actions/pre-steps/action.yml index 345c2ce..13f36f1 100644 --- a/.github/actions/pre-steps/action.yml +++ b/.github/actions/pre-steps/action.yml @@ -11,7 +11,7 @@ runs: shell: bash - name: Clone rocksdb run: | - git clone --depth 1 --branch v8.5.3 https://github.com/facebook/rocksdb.git + git clone --depth 1 https://github.com/facebook/rocksdb.git shell: bash - uses: actions/checkout@v4 with: diff --git a/.github/workflows/sanity_check.yml b/.github/workflows/sanity_check.yml index 2702836..c4952d7 100644 --- a/.github/workflows/sanity_check.yml +++ b/.github/workflows/sanity_check.yml @@ -23,7 +23,7 @@ jobs: run: pip install argparse - name: Clone rocksdb run: | - git clone --depth 1 --branch v8.5.3 https://github.com/facebook/rocksdb.git + git clone --depth 1 https://github.com/facebook/rocksdb.git shell: bash - uses: actions/checkout@v4 with: diff --git a/README.md b/README.md index 82336e6..1bd4656 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@ The `AESEncryptionProvider` of `EncryptionFileSystem` is an encryption plugin for RocksDB. It depends on OpenSSL to show how an external plugin can bring its dependencies into the RocksDB build. It provides a factory function in a header file to show integration with RocksDB header includes. It can also be enabled in text-based options to demonstrate use of the static registration framework. ## Build -Download the RocksDB code from the official repository. Currently, version 8.5.3 is used as the benchmark for testing. +Download the RocksDB code from the official repository. ``` -git clone --depth 1 --branch v8.5.3 https://github.com/facebook/rocksdb.git +git clone --depth 1 https://github.com/facebook/rocksdb.git ``` The code first needs to be linked under RocksDB's `plugin/` directory. In your RocksDB directory, run: