Skip to content

Commit

Permalink
Added :wqdocumentation and GH actions for sculpting feature
Browse files Browse the repository at this point in the history
Signed-off-by: Abhijit Gadgil <[email protected]>
  • Loading branch information
gabhijit committed May 5, 2024
1 parent 2e33d41 commit 3e4f151
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,14 @@ jobs:
- name: install maturin
run: |
python -m pip install maturin==0.13.6
- name: install rustup
run: |
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > rustup-init.sh
sh rustup-init.sh -y --default-toolchain none
rustup target add ${{ matrix.target }}
rustup default ${{ matrix.cfg_release_channel }}
- name: Build with Python Bindings
run: |
maturin build --verbose --features python-bindings,logging --release --out dist
Expand All @@ -62,3 +64,6 @@ jobs:

- name: Run wasm-pack tests in node
run: wasm-pack test --node --features wasm

- name: Build and test with sculpting feature enabled
run: cargo build --features sculpting && cargo test --features sculpting
2 changes: 2 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
//! feature is enabled.
//! - `wasm`: Build WASM capability in the scalpel. Currently `dissect_packet` API is provided,
//! dissects the packet and a JSON is generated for the packet.
//! - `sculpting`: Experimental, allows one to generate packet from layers using metadata. For
//! example this will be useful to develop packet generators.
//!
//! Note: `wasm` and `python-bindings` features cannot be enabled at the same time.
Expand Down

0 comments on commit 3e4f151

Please sign in to comment.