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

Examples fix table names #4

Open
wants to merge 202 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
202 commits
Select commit Hold shift + click to select a range
9fbb37e
cassandra/docker-compose: go back to using the latest cassandra version
cvybhu Oct 19, 2023
2792714
benches: make them compile again
piodul Oct 20, 2023
9965289
CI: check/build all targets in rust workflow
piodul Oct 20, 2023
5830269
Merge pull request #853 from piodul/fix-benchest-and-test-all-targets…
Lorak-mmk Oct 26, 2023
5b0096b
Commit renamed Cargo.lock file
Lorak-mmk Oct 26, 2023
4c60b01
Merge pull request #856 from Lorak-mmk/fix_toml_datetime
piodul Oct 26, 2023
a5d5345
Merge pull request #850 from cvybhu/latest-cassandra
Lorak-mmk Nov 2, 2023
270e3dc
scylla-cql: Improve support of common date and time types
Anfid Jun 8, 2023
04b5420
value_tests: fix clippy's new complaint about needless_borrows_for_ge…
piodul Nov 17, 2023
e1c9105
Merge pull request #861 from piodul/clippy-fixes-1.74
Lorak-mmk Nov 17, 2023
7767f17
types: introduce read_value
piodul Oct 20, 2023
5e544c9
frame: adjust serialized values iterator to return RawValue
piodul Oct 20, 2023
4e0d540
Proxy: Allow filtering out control connection messages
Lorak-mmk Nov 8, 2023
35f7717
integration/consistency.rs: ignore control connection messages
Lorak-mmk Nov 11, 2023
3d58669
integration/shards.rs: ignore control connection messages
Lorak-mmk Nov 11, 2023
7092296
scylla-proxy: Add Tokio signal feature to dev deps
Lorak-mmk Nov 20, 2023
156ee60
Merge pull request #863 from Lorak-mmk/proxy-filter-controll-conn
piodul Nov 21, 2023
29a37b4
types: serialize: introduce new helpers for writing values and adjust…
piodul Oct 20, 2023
46e33c9
Merge pull request #855 from piodul/adjust-interface
piodul Nov 24, 2023
fa709c6
SerializationError: dyn Error instead of dyn Any
Lorak-mmk Nov 8, 2023
7bcc461
scylla-cql: make SerializationError a newtype instead of alias
Lorak-mmk Nov 21, 2023
2f78d46
Merge pull request #865 from Lorak-mmk/serialization_error_newtype
piodul Dec 1, 2023
33413a4
frame/value: introduce ValueOverflow error
piodul Nov 16, 2023
067a5af
frame/value_tests: exercise both old and new ser cql traits
piodul Oct 29, 2023
a07ee60
frame/value_tests: add tests for types that didn't have ones
piodul Nov 20, 2023
fc101d9
serialize/writers: make overflow errors easier to handle
piodul Nov 30, 2023
5790698
types/serialize: add a shorthand for constructing SerializationError
piodul Dec 4, 2023
44d4374
serialize/value: make fallbacks for `SerializeCql` explicit
piodul Oct 27, 2023
baa6284
serialize/value: impl SerializeCql for fixed size numbers
piodul Nov 20, 2023
6076aa5
serialize/value: impl SerializeCql for string types
piodul Nov 19, 2023
ee9cb2a
serialize/value: impl SerializeCql for byte containers
piodul Nov 19, 2023
9768381
serialize/value: impl SerializeCql for uuid/timeuuid
piodul Nov 19, 2023
3214d1d
serialize/value: impl SerializeCql for inet
piodul Nov 19, 2023
6ffc2c2
serialize/value: impl SerializeCql for dynamically sized numbers
piodul Nov 20, 2023
575f0d6
serialize/value: impl SerializeCql for time-related types
piodul Nov 20, 2023
ceb37e2
serialize/value: impl SerializeCql for sequence types
piodul Nov 19, 2023
491772f
serialize/value: impl SerializeCql for map types
piodul Nov 19, 2023
13cb25b
serialize/value: impl SerializeCql for tuples
piodul Nov 19, 2023
deb6a81
frame/value: don't require trait on MaybeUnset parameter
piodul Nov 3, 2023
ed6bfa4
serialize/value: impl SerializeCql for wrapper types
piodul Nov 19, 2023
7b0f3fd
response/result: add helper `supports_special_empty_value`
piodul Nov 19, 2023
1952100
serialize/value: impl SerializeCql for CqlValue
piodul Nov 19, 2023
4db6a5c
frame/value_tests: check that UDTs sort fields
piodul Nov 20, 2023
3bc8972
frame/value_test: exercise both old and new row ser traits
piodul Nov 17, 2023
025b89e
serialize/row: make fallbacks for `SerializeRow` explicit
piodul Nov 3, 2023
e65102c
serialize/row: impl SerializeRow for unit types
piodul Nov 20, 2023
6f7b086
serialize/row: impl SerializeRow for dynamically sized rows
piodul Nov 20, 2023
7b91d79
serialize/row: impl SerializeRow for map types
piodul Nov 20, 2023
bb46597
serialize/row: impl SerializeRow for reference
piodul Nov 20, 2023
0932444
serialize/row: impl SerializeRow for tuples
piodul Nov 20, 2023
0642eb5
serialize: provide macro for quick trait impl from legacy
piodul Dec 4, 2023
bdcf349
Merge pull request #862 from piodul/implement-for-new-serialization
piodul Dec 5, 2023
eb10f3b
SerializeRow: Add is_empty method
Lorak-mmk Nov 11, 2023
b158aca
Merge pull request #869 from Lorak-mmk/serialize_row_is_empty
piodul Dec 6, 2023
3be1149
CI: use container hostname in healthcheck
piodul Dec 8, 2023
d7fa0ce
Merge pull request #873 from piodul/ci-use-container-hostname
Lorak-mmk Dec 8, 2023
9119af4
serialize/writers: get rid of counting writers
piodul Dec 7, 2023
ff9e363
serialize/writers: simplify tests
piodul Dec 7, 2023
a7aa5d5
serialize/writers: add WrittenCellProof
piodul Dec 6, 2023
e696663
serialize/row: de-genericise SerializeRow
piodul Dec 7, 2023
f374ba7
serialize/value: de-genericise SerializeCql
piodul Dec 7, 2023
d37b2c4
serialize/writers: replace writer traits with buffer-backed impls
piodul Dec 7, 2023
458c4de
serialze/writers: move `new`/`value_count` methods higher
piodul Dec 7, 2023
9dc39fd
serialize: provide default preliminary typecheck impls
piodul Dec 7, 2023
6d7cc98
serialize/value: move exact typechecks to serialize
piodul Dec 7, 2023
cc0a1a0
serialize/value: move CqlValue's typecheck to serialize
piodul Dec 8, 2023
69cb8f4
serialize/value: remove nested typecheck errors
piodul Dec 8, 2023
53b7349
serialize/value: remove typechecks of compound types
piodul Dec 8, 2023
e8a92ad
serialize/value: remove remaining preliminary type check impls
piodul Dec 8, 2023
6e074d5
serialize/row: fix incorrect error being returned
piodul Dec 8, 2023
5eddc08
serialize/row: remove preliminary type check impls
piodul Dec 8, 2023
006dc35
serialize: remove `preliminary_type_check` method
piodul Dec 8, 2023
ef6e428
serialize/value: inline check_and_serialize into callers
piodul Dec 8, 2023
6a1ea41
serialize/row: relax restriction on SerializeRow impl on reference
piodul Dec 8, 2023
5733a2f
serialize: tests for dyn SerializeCql/dyn SerializeRow
piodul Dec 8, 2023
6c9ec8f
Merge pull request #871 from piodul/serialize-trait-genericide
piodul Dec 9, 2023
80a59a9
scylla-macros: introduce SerializeCql derive macro
piodul Oct 20, 2023
30a69f8
scylla-macros: introduce SerializeRow derive macro
piodul Oct 20, 2023
dcb4cf4
scylla-macros: implement enforce_order flavor of SerializeCql
piodul Oct 27, 2023
a255d81
scylla-macros: implement enforce_order flavor of SerializeRow
piodul Oct 27, 2023
b26e5bd
Merge pull request #851 from piodul/serialization-refactor-macros
piodul Dec 9, 2023
64452dd
Typos: fix minor typos in code
mykaul Dec 9, 2023
7d06b89
Merge pull request #876 from mykaul/spelling
piodul Dec 11, 2023
0b0d02d
RowSerializationContext: Add from_prepared method
Lorak-mmk Nov 11, 2023
18d6393
scylla-cql: Add SerializationError variant for QueryError
Lorak-mmk Nov 8, 2023
ca30092
connection.rs: Don't allow queries with values
Lorak-mmk Nov 8, 2023
dc2b02e
Rename SerializedValues to LegacySerializedValues
Lorak-mmk Dec 5, 2023
869c5a0
Makefile: build and check benches
Lorak-mmk Dec 11, 2023
f01029f
Merge pull request #877 from Lorak-mmk/benches-in-ci
piodul Dec 12, 2023
d0e8502
scylla-cql: Implement SerializedValues
Lorak-mmk Nov 12, 2023
0ddaa9a
PreparedStatement: Add `serialize_values` helper method
Lorak-mmk Dec 11, 2023
4a18a94
scylla: export scylla_cql::types::serialize
Lorak-mmk Dec 11, 2023
8677601
ClusterData: Switch `get_endpoints` to new serialization API
Lorak-mmk Dec 11, 2023
a523582
ClusterData: switch `compute_token` to new serialization API
Lorak-mmk Dec 11, 2023
de7fc31
PreparedStatement: Switch `calculate_token` to new serialization API
Lorak-mmk Dec 11, 2023
0f63636
PreparedStatement: Switch `compute_partition_key` to new Serializatio…
Lorak-mmk Dec 11, 2023
c724068
RequestSpan: record request sizes lazily
Lorak-mmk Dec 11, 2023
0545568
Session: switch `query_paged` method to new serialization API
Lorak-mmk Dec 11, 2023
50fb19d
Session: switch `query_iter` to new serialization API
Lorak-mmk Dec 11, 2023
615cc33
Session: switch `execute_paged` method to new serialization API
Lorak-mmk Dec 11, 2023
8675646
Session: switch `execute_iter` to new serialization API
Lorak-mmk Dec 11, 2023
5ebb2d2
Session: switch `execute` to new serialization API
Lorak-mmk Dec 11, 2023
9bf7b77
examples: Use both new and old serialization APIs
Lorak-mmk Dec 11, 2023
6cc643a
cql_collections_test: Use both new and old serialization APIs
Lorak-mmk Dec 11, 2023
ea93d39
cql_types_test: Use both new and old serialization APIs
Lorak-mmk Dec 11, 2023
ac88e0a
session_test: Use both new and old serialization APIs
Lorak-mmk Dec 11, 2023
b3261cd
Session: switch `query` method to new serialization API
Lorak-mmk Dec 11, 2023
25a6d36
Book: Derive new serialization traits in udt.md and values.md
Lorak-mmk Dec 12, 2023
c353f17
examples: Remove usage of old serialization APIs
Lorak-mmk Dec 11, 2023
8a33467
cql_collections_test: Remove usage of old serialization APIs
Lorak-mmk Dec 11, 2023
72a81ce
cql_types_test: Remove usage of old serialization APIs
Lorak-mmk Dec 11, 2023
c7e766e
session_test: Remove usage of old serialization macros / traits
Lorak-mmk Dec 11, 2023
4a09baa
CachingSession: Use new serialization APIs
Lorak-mmk Dec 11, 2023
3d32c1c
RowIterator: switch `new_for_prepared_statement` to new serialization…
Lorak-mmk Dec 11, 2023
d3b884b
topology: type-safe serialization in query_filter_keyspace_name
Lorak-mmk Dec 11, 2023
d5b8636
Connection: switch `execute_iter` to new serialization API
Lorak-mmk Dec 11, 2023
a4a27de
RowIterator: switch `new_for_connection_execute_iter` to new serializ…
Lorak-mmk Dec 11, 2023
7ae1abb
Connection: switch `execute` method to new serialization API
Lorak-mmk Dec 11, 2023
5960e3b
Connection: switch `execute_with_consistency` to new serialization API
Lorak-mmk Dec 11, 2023
991ea48
PreparedStatement: switch `extract_partition_key*` and `PrimaryKey::n…
Lorak-mmk Dec 11, 2023
4d5c33a
partitioner: switch `calculate_token_for_partition_key` to new serial…
Lorak-mmk Dec 11, 2023
ee61cb0
QueryParameters: switch `values` to new `SerializedValues`
Lorak-mmk Dec 11, 2023
a35b5b3
scylla: Remove most uses of fallback SerializeRow impls
Lorak-mmk Dec 11, 2023
64c6ac6
Remove unnecessary `#[allow(dead_code)]`
Lorak-mmk Dec 11, 2023
969d37e
Merge pull request #858 from Lorak-mmk/switch-serialization-traits
piodul Dec 12, 2023
7030873
serialize/{row,value}: rename confusing "mismatch" variants
piodul Dec 13, 2023
bdabeec
serialize/row: check for unused named values in legacy fallback
piodul Dec 11, 2023
2810faf
serialize/value: dedicated error variant for too big legacy values
piodul Dec 11, 2023
e57a7f8
serialize/value: fix error returned from dynamic tuples
piodul Dec 12, 2023
fa1cf21
frame/value: implement some common traits for Unset
piodul Dec 12, 2023
53d1490
serialize/{row,value}: add tests for serialization errors
piodul Dec 12, 2023
7cf355b
serialize: document all public items
piodul Dec 11, 2023
10b49ef
Merge pull request #878 from piodul/docstrings-and-tests
piodul Dec 14, 2023
7fe1ef8
treewide: add Legacy- prefix to BatchValues and its friends
piodul Dec 13, 2023
d83c9e2
serialize: optimize copying values from SerializedValues to RowWriter
piodul Dec 14, 2023
8715498
serialize/row: add RowSerializationContext::empty
piodul Dec 14, 2023
daa5266
serialize/row: simplify SerializedValues::from_serializable
piodul Dec 14, 2023
cc83cb6
serialize/row: add SerializedValues::from_closure method
piodul Dec 14, 2023
1e61f9c
session: construct RoutingInfo outside the match
piodul Dec 14, 2023
e90975e
session: inline the .as_deref() call
piodul Dec 14, 2023
ccd60b3
session: construct first_serialized_value in a narrower scope
piodul Dec 14, 2023
5ffd3ab
session: work around lifetime issues with temporaries
piodul Dec 14, 2023
2f88124
prepared_statement: add calculate_token_untyped method
piodul Dec 14, 2023
51bf7ab
frame: use Vec<u8> for request serialization, not BufMut
piodul Dec 13, 2023
4478f6a
scylla-macros: allow renaming fields in UDTs
piodul Dec 15, 2023
37f17e2
scylla-macros: allow renaming fields in rows
piodul Dec 15, 2023
eaafc96
scylla-macros: simplify handling of flavor
piodul Dec 15, 2023
344112a
scylla-macros: add skip_name_checks attribute to SerializeCql
piodul Dec 15, 2023
39908a6
scylla-macros: add skip_name_checks attribute to SerializeRow
piodul Dec 15, 2023
8f360c5
Merge pull request #882 from piodul/macros-name-checking-improvements
Lorak-mmk Dec 15, 2023
067ccf9
Docs: Add warnings about performance of query
Lorak-mmk Dec 14, 2023
bc97ffd
Docs: Update informations about serialization
Lorak-mmk Dec 14, 2023
25d8d9c
serialize: introduce new BatchValues and friends
piodul Dec 13, 2023
cb7787d
raw_batch: implement RawBatchValueAdapter
piodul Dec 13, 2023
a9b7da3
statement/batch: reintroduce BatchValuesFirstSerialized
piodul Dec 14, 2023
6b88c7e
scylla-cql/frame, scylla/{statement,transport}: switch to new API
piodul Dec 14, 2023
e6c2aa5
session: move the batch token awareness logic to a separate function
piodul Dec 14, 2023
666ca25
serialize/batch: add compatibility layer for the legacy API
piodul Dec 15, 2023
2ea431c
value_tests: adapt batch tests to both new and legacy API
piodul Dec 15, 2023
fbeafd7
serialize/row: remove SerializedValues::to_old_serialized_values
piodul Dec 14, 2023
83d78b0
Merge pull request #880 from Lorak-mmk/serialization-documentation
piodul Dec 15, 2023
99330c8
Merge pull request #881 from piodul/new-serialize-api-batches
Lorak-mmk Dec 15, 2023
8c06b18
impl Default for MaybeUnset
RoDmitry Dec 16, 2023
778a46c
docs: update batch.md to warn about automatic preparation
piodul Dec 18, 2023
abee437
serialize: add `ValueAdapter` and `ValueListAdapter`
piodul Dec 18, 2023
f448192
Merge pull request #883 from RoDmitry/MaybeUnset-default
piodul Dec 18, 2023
0edaaca
Merge pull request #886 from piodul/update-batch-page
Lorak-mmk Dec 18, 2023
1f66942
docs: add migration guide for pre-0.11 serialization
piodul Dec 15, 2023
187c331
Merge pull request #887 from piodul/migration-guide
Lorak-mmk Dec 18, 2023
eb8a1e1
macros: Add `force_exact_match` attribute to SerializeCql
Lorak-mmk Dec 18, 2023
77fb6e2
scylla-cql: Test new behavior of SerializeCql
Lorak-mmk Dec 18, 2023
a0eaff0
Merge pull request #885 from Lorak-mmk/more_lenient_serialize_macros
piodul Dec 18, 2023
bce8d24
scylla-macros: bump version to 0.2.2
Lorak-mmk Dec 18, 2023
b5faf8b
scylla-cql: bump version to 0.0.10
Lorak-mmk Dec 18, 2023
449ec0c
scylla: bump version to 0.11.0
Lorak-mmk Dec 18, 2023
f5ee5be
Docs: Fix code blocks in migration guide
Lorak-mmk Dec 19, 2023
0d6addc
docs: Fix broken link to new migration guide
Lorak-mmk Dec 19, 2023
e482455
Docs: replace table with list
Lorak-mmk Dec 19, 2023
4fa4530
scylla-macros: bump version to 0.3.0
Lorak-mmk Dec 21, 2023
6c62b52
scylla-cql: bump version to 0.0.11
Lorak-mmk Dec 21, 2023
4a4fd0e
scylla: bump version to 0.11.1
Lorak-mmk Dec 21, 2023
5714db1
scylla-cql: Use `#[cfg(feature = "time")]` for `time` related `impl S…
oeb25 Dec 28, 2023
da20f05
scylla-cql: work around the lint about supposedly no-op .map
piodul Dec 29, 2023
0dbdfd9
examples: compare-tokens: use .first() instead of .get(0)
piodul Dec 29, 2023
8263c53
Merge pull request #900 from piodul/clippy-fixes-1.75
Lorak-mmk Jan 2, 2024
c23cad4
Add CI steps for `cargo check` with each serialization feature indivi…
oeb25 Dec 31, 2023
2faeba0
Merge pull request #898 from oeb25/misplaced-chrono-feature
piodul Jan 3, 2024
654734d
Add `skip` field attribute to SerializeCql
Lorak-mmk Jan 4, 2024
5a0b285
Add `skip` attribute to SerializeRow
Lorak-mmk Jan 4, 2024
befa148
Merge pull request #903 from Lorak-mmk/serialize_skip_field
piodul Jan 4, 2024
60392ed
scylla: create macros module
Lorak-mmk Jan 9, 2024
4c154ba
scylla-macros: Replace derive macros docs with stubs
Lorak-mmk Jan 9, 2024
f6b9ee1
Move derive macros docs to scylla crate
Lorak-mmk Jan 9, 2024
64470f7
scylla-cql: Inline `macros` module
Lorak-mmk Jan 9, 2024
5c7c12b
Adjust macros docs to new paths
Lorak-mmk Jan 9, 2024
32411d3
scylla: Add separators in derive macros docs
Lorak-mmk Jan 12, 2024
7933112
scylla: Add empty lines in old derive macros docs
Lorak-mmk Jan 12, 2024
8040546
Book: Add a sphinx preprocessor
Lorak-mmk Jan 11, 2024
9b8ef00
Docs: Remove build_book.py script and it's mentions
Lorak-mmk Jan 11, 2024
c9aecf4
Merge pull request #910 from Lorak-mmk/book-preprocessor
piodul Jan 12, 2024
e86823b
Merge pull request #907 from Lorak-mmk/workaround_macros_docs
piodul Jan 12, 2024
86e42f6
Update keyspace and table names in examples
nsipplswezey Oct 17, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/workflows/book.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
image: scylladb/scylla
ports:
- 9042:9042
options: --health-cmd "cqlsh --debug" --health-interval 5s --health-retries 10
options: --health-cmd "cqlsh --debug scylladb" --health-interval 5s --health-retries 10
steps:
- uses: actions/checkout@v3
- name: Install mdbook
Expand All @@ -33,7 +33,5 @@ jobs:
run: cargo build --verbose --examples
- name: Build the book
run: mdbook build docs
- name: Build the book using the script
run: python3 docs/build_book.py
- name: Run book tests
run: mdbook test -L target/debug/deps docs
4 changes: 2 additions & 2 deletions .github/workflows/cassandra.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ jobs:
docker compose -f test/cluster/cassandra/docker-compose.yml up -d --wait
# A separate step for building to separate measuring time of compilation and testing
- name: Build the project
run: cargo build --verbose --tests
run: cargo build --verbose --tests --features "full-serialization"
- name: Run tests on cassandra
run: |
CDC='disabled' SCYLLA_URI=172.42.0.2:9042 SCYLLA_URI2=172.42.0.3:9042 SCYLLA_URI3=172.42.0.4:9042 cargo test --verbose -- --skip test_views_in_schema_info --skip test_large_batch_statements
CDC='disabled' SCYLLA_URI=172.42.0.2:9042 SCYLLA_URI2=172.42.0.3:9042 SCYLLA_URI3=172.42.0.4:9042 cargo test --verbose --features "full-serialization" -- --skip test_views_in_schema_info --skip test_large_batch_statements
- name: Stop the cluster
if: ${{ always() }}
run: docker compose -f test/cluster/cassandra/docker-compose.yml stop
Expand Down
28 changes: 18 additions & 10 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,23 @@ jobs:
- name: Format check
run: cargo fmt --verbose --all -- --check
- name: Clippy check
run: cargo clippy --verbose --examples --tests -- -Aclippy::uninlined_format_args
run: cargo clippy --verbose --all-targets -- -Aclippy::uninlined_format_args
- name: Cargo check without features
run: cargo check --manifest-path "scylla/Cargo.toml" --features ""
- name: Cargo check with secrecy feature
run: cargo check --manifest-path "scylla/Cargo.toml" --features "secret"
run: cargo check --all-targets --manifest-path "scylla/Cargo.toml" --features ""
- name: Cargo check with all serialization features
run: cargo check --all-targets --manifest-path "scylla/Cargo.toml" --features "full-serialization"
- name: Cargo check with secret feature
run: cargo check --all-targets --manifest-path "scylla/Cargo.toml" --features "secret"
- name: Cargo check with chrono feature
run: cargo check --all-targets --manifest-path "scylla/Cargo.toml" --features "chrono"
- name: Cargo check with time feature
run: cargo check --all-targets --manifest-path "scylla/Cargo.toml" --features "time"
- name: Build scylla-cql
run: cargo build --verbose --all-targets --manifest-path "scylla-cql/Cargo.toml"
run: cargo build --verbose --all-targets --manifest-path "scylla-cql/Cargo.toml" --features "full-serialization"
- name: Build
run: cargo build --verbose --examples
run: cargo build --verbose --all-targets --features "full-serialization"
- name: Run tests
run: SCYLLA_URI=172.42.0.2:9042 SCYLLA_URI2=172.42.0.3:9042 SCYLLA_URI3=172.42.0.4:9042 cargo test --verbose
run: SCYLLA_URI=172.42.0.2:9042 SCYLLA_URI2=172.42.0.3:9042 SCYLLA_URI3=172.42.0.4:9042 cargo test --verbose --features "full-serialization"
- name: Stop the cluster
if: ${{ always() }}
run: docker compose -f test/cluster/docker-compose.yml stop
Expand All @@ -60,12 +66,14 @@ jobs:
rustup override set ${{ env.rust_min }}
- name: Print Rust version
run: rustc --version
- name: Use MSRV Cargo.lock
run: mv Cargo.lock.msrv Cargo.lock
- name: MSRV cargo check with features
run: cargo check --verbose --examples --tests
run: cargo check --verbose --all-targets --all-features --locked
- name: MSRV cargo check without features
run: cargo check --verbose --manifest-path "scylla/Cargo.toml"
run: cargo check --verbose --all-targets --locked --manifest-path "scylla/Cargo.toml"
- name: MSRV cargo check scylla-cql
run: cargo check --verbose --all-targets --manifest-path "scylla-cql/Cargo.toml"
run: cargo check --verbose --all-targets --locked --manifest-path "scylla-cql/Cargo.toml"

# Tests that docstrings generate docs without warnings
cargo_docs:
Expand Down
15 changes: 9 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,17 +72,20 @@ But they are removed when building the book
cargo install mdbook
```

Build the book (simple method, contains `Sphinx` artifacts):
Book build process uses preprocessor to remove Sphinx artifacts.
Due to limitation of mdbook, it can only be built either from main directory,
using `mdbook X docs` or from `docs` directory, using `mdbook X`, where
`X` is mdbook command such as `build` / `serve` / `test` etc.

If the book is built from another directory (e.g. scylla, using `mdbook build ../docs`),
preprocessor won't be found, so the result will contain Sphinx artifacts.

Build the book.
```bash
mdbook build docs
# HTML will be in docs/book
```

To build the release version use a script which automatically removes `Sphinx` chunks:
```bash
python3 docs/build_book.py
# HTML will be in docs/book/scriptbuild/book
```

Or serve it on a local http server (automatically refreshes on changes)
```bash
Expand Down
Loading