justfile to ease usual commands and workflows

Author: github-af

.github/workflows/clippy.yml

@@ -17,8 +17,13 @@ jobs:
     steps:
       - uses: actions/checkout@v6
 
+      - name: Install system dependencies
+        run: |
+          sudo apt update
+          sudo apt install just
+
       - name: Update rust
         run: rustup update
 
       - name: Run clippy
-        run: cargo clippy --all-targets --all-features --workspace
+        run: just clippy

.github/workflows/doc.yml

@@ -9,16 +9,24 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v6
-    - uses: actions/setup-python@v4
-    - name: Prepare
-      run: pip install sphinx sphinx_rtd_theme
-    - name: Build
-      run: sphinx-build doc doc/_build
-    - name: Deploy
-      uses: JamesIves/github-pages-deploy-action@v4
-      with:
-        branch: gh-pages
-        folder: doc/_build
-        clean: true
-        token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt update
+          sudo apt install just
+
+      - name: Prepare
+        run: pip install sphinx sphinx_rtd_theme
+
+      - name: Build
+        run: just doc
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: doc/_build
+          clean: true
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -19,18 +19,24 @@ jobs:
     steps:
       - uses: actions/checkout@v6
 
+      - name: Install system dependencies
+        run: |
+          sudo apt update
+          sudo apt install just
+
       - name: Update rust
         run: rustup update
 
       - name: Build release
-        run: cargo build --release
+        run: just release
 
       - name: Gather artifacts
         run: |
           mkdir -p artifacts/release/
           cp target/release/lidi-{receive,send} artifacts/release/
           cp target/release/lidi-{flood,oneshot}-{receive,send} artifacts/release/
           cp target/release/lidi-{receive,send}-{file,udp} artifacts/release/
+          cp target/release/lidi-network-simulator artifacts/release/
           cp target/release/liblidi_bindings.so artifacts/release/
 
       - name: Upload release artifacts

.github/workflows/tests.yml

@@ -18,15 +18,14 @@ jobs:
     steps:
       - uses: actions/checkout@v6
 
+      - name: Install system dependencies
+        run: |
+          sudo apt update
+          sudo apt install python3-pip python3-virtualenv libfuse2t64 just
+
       - name: Update rust
         run: rustup update
 
-      - name: Run cargo tests
-        run: cargo test
-
-      - name: Install system dependencies
-        run: sudo apt install python3-pip python3-virtualenv libfuse2t64
-
       - name: Create virtualenv
         run: virtualenv venv
 
@@ -35,7 +34,8 @@ jobs:
           source venv/bin/activate
           pip install behave fusepy psutil
 
-      - name: Run simple integration tests
+      - name: Run tests
         run: |
           source venv/bin/activate
-          behave --tags=~fail features/simple.feature
+          just test
+

justfile

@@ -0,0 +1,31 @@
+release:
+    cargo build --release
+
+release_tcp_mmsg:
+    cargo build --release --no-default-features --features from-tcp,to-tcp,tcp,receive-mmsg,send-mmsg,tcp
+
+release_tls_native:
+    cargo build --release --no-default-features --features from-tls,to-tls,tls,receive-native,send-native
+
+clean:
+    cargo clean
+
+fmt:
+    cargo +nightly fmt
+
+check:
+    cargo check --all-targets --all-features
+
+clippy:
+    cargo clippy --all-targets --all-features
+
+bench:
+    cargo bench --all-features
+
+test:
+    #behave features/*.feature
+    behave --tags=~fail features/simple.feature
+
+doc:
+    sphinx-build doc doc/_build
+