Skip to content

Update README.md

Update README.md #717

Workflow file for this run

name: "CI/CD"
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
env:
CARGO_TERM_COLOR: always
jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ ubuntu-latest, macos-latest, windows-latest ] # macos tends to break more often.
continue-on-error: false
steps:
- uses: actions/checkout@v4
- name: Set up Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
profile: minimal
- name: Install winget
if: runner.os == 'Windows'
uses: Cyberboss/install-winget@v1
# Fail cheaply and early if the code is not even formatted correctly.
- name: Cargo fmt check
run: cargo fmt --all -- --check
## System dependencies
# Install dependencies only on Linux
- name: Install dependencies (Linux)
if: runner.os == 'Linux'
run: sudo apt-get update && sudo apt-get install -y libudev-dev libpcap-dev
# Those are needed for the integration tests on Windows
- name: Download Npcap SDK (Windows)
if: runner.os == 'Windows'
run: |
Invoke-WebRequest -Uri https://npcap.com/dist/npcap-sdk-1.13.zip -OutFile npcap-sdk.zip
Expand-Archive -Path npcap-sdk.zip -DestinationPath $env:USERPROFILE\npcap-sdk
Remove-Item npcap-sdk.zip
winget install --id DaiyuuNobori.Win10Pcap --disable-interactivity --accept-source-agreements --accept-package-agreements
- name: Set Library and Include Paths (Windows)
if: runner.os == 'Windows'
run: |
$npcapLibDir = "$env:USERPROFILE\npcap-sdk\Lib\x64"
Add-Content -Path $env:GITHUB_ENV -Value "LIB=$npcapLibDir"
## End of system dependencies
- name: Install cargo-generate
run: cargo install cargo-generate
- name: Run clippy
run: cargo clippy -- -W warnings
- name: Build vanilla
run: |
cargo build --workspace --features macro_debug
- name: Build with mocks
run: |
cargo build --workspace --features mock
- name: Run tests
env:
LIB: ${{env.LIB}}
run: cargo test --workspace
# Integration Test for the 1 liner generation of a project.
- name: Generate a test project from the repo template
run: |
cd templates
cargo generate -p cu_full --name test_project --destination . -d copper_source=local --silent
- name: Compile generated project
run: |
cd templates/test_project
cargo build --release