Skip to content

Commit

Permalink
Update readme to use the main branch of facebook/rocksdb (#5)
Browse files Browse the repository at this point in the history
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:
facebook/rocksdb@76402c0
facebook/rocksdb@c4c62c2
  • Loading branch information
acelyc111 committed Nov 15, 2023
1 parent c219b6b commit 14b6a8d
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/actions/pre-steps-macos/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/pre-steps/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sanity_check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 14b6a8d

Please sign in to comment.