Merge remote-tracking branch 'origin/develop' into feat/consolidated_…

…hashes

.github/labeler.yml

@@ -23,12 +23,17 @@
 - changed-files:
   - any-glob-to-any-file: zero_bin/**
 
-# Add 'specs' label to any changes within 'docs' folder.
+# Add 'specs' label to any changes within 'docs' or `book` folder.
 'specs':
 - changed-files:
-  - any-glob-to-any-file: docs/**
+  - any-glob-to-any-file: ['docs/**', 'book/**']
 
 # Add 'crate: common' label to any changes within 'common' folder.
 'crate: common':
   - changed-files:
       - any-glob-to-any-file: common/**
+
+# Add 'ci' label to any changes within '.github' folder.
+'ci':
+  - changed-files:
+      - any-glob-to-any-file: .github/**

.github/workflows/book.yml

@@ -3,9 +3,12 @@ name: zkEVM mdbook
 on:
   push:
     branches: [develop, main]
+  pull_request:
+    branches:
+      - "**"
 
 jobs:
-  deploy:
+  build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -20,15 +23,37 @@ jobs:
           command: install
           args: mdbook
 
-      - name: Install mdbook-katex and mdbook-bib
+      - name: Install preprocessors
         uses: actions-rs/cargo@v1
         with:
           command: install
-          args: mdbook-katex mdbook-bib
+          args: mdbook-katex mdbook-bib mdbook-mermaid
+
+      - name: Initialize mermaid preprocessor
+        run: mdbook-mermaid install book
 
       - name: Build book
         run: mdbook build book
 
+      - name: Upload built book
+        uses: actions/upload-artifact@v3
+        with:
+          name: built-mdbook
+          path: ./book/book
+
+  deploy:
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop')
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Download built book
+        uses: actions/download-artifact@v3
+        with:
+          name: built-mdbook
+          path: ./book/book
+
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
     name: Test mpt_trie
     runs-on: ubuntu-latest
     timeout-minutes: 30
-    if: "! contains(toJSON(github.event.commits.*.message), '[skip-ci]')"
+    if: ${{ ! contains(toJSON(github.event.commits.*.message), '[skip-ci]') }}
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
@@ -47,7 +47,12 @@ jobs:
     name: Test trace_decoder
     runs-on: zero-ci
     timeout-minutes: 30
-    if: "! contains(toJSON(github.event.commits.*.message), '[skip-ci]')"
+    env:
+      RUST_LOG: info
+      CARGO_INCREMENTAL: 1
+      RUST_BACKTRACE: 1
+
+    if: ${{ ! contains(toJSON(github.event.commits.*.message), '[skip-ci]') }}
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
@@ -60,18 +65,17 @@ jobs:
         with:
           cache-on-failure: true
 
-      - name: Test in trace_decoder subdirectory
+      - name: build # build separately so test logs are actually nice
+        run: cargo build --tests --manifest-path trace_decoder/Cargo.toml
+
+      - name: test
         run: cargo test --release --manifest-path trace_decoder/Cargo.toml -- --nocapture
-        env:
-          RUST_LOG: info
-          CARGO_INCREMENTAL: 1
-          RUST_BACKTRACE: 1
 
   test_proof_gen:
     name: Test proof_gen
     runs-on: ubuntu-latest
     timeout-minutes: 30
-    if: "! contains(toJSON(github.event.commits.*.message), '[skip-ci]')"
+    if: ${{ ! contains(toJSON(github.event.commits.*.message), '[skip-ci]') }}
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
@@ -96,7 +100,7 @@ jobs:
     name: Test evm_arithmetization
     runs-on: ubuntu-latest
     timeout-minutes: 30
-    if: "! contains(toJSON(github.event.commits.*.message), '[skip-ci]')"
+    if: ${{ ! contains(toJSON(github.event.commits.*.message), '[skip-ci]') }}
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
@@ -121,7 +125,7 @@ jobs:
     name: Test zero_bin
     runs-on: ubuntu-latest
     timeout-minutes: 30
-    if: "! contains(toJSON(github.event.commits.*.message), '[skip-ci]')"
+    if: ${{ ! contains(toJSON(github.event.commits.*.message), '[skip-ci]') }}
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
@@ -132,7 +136,7 @@ jobs:
       - name: Set up rust cache
         uses: Swatinem/rust-cache@v2
         with:
-            cache-on-failure: true
+          cache-on-failure: true
 
       - name: Test in zero_bin subdirectory
         run: |
@@ -154,7 +158,7 @@ jobs:
     name: Test zk_evm_proc_macro
     runs-on: ubuntu-latest
     timeout-minutes: 30
-    if: "! contains(toJSON(github.event.commits.*.message), '[skip-ci]')"
+    if: ${{ ! contains(toJSON(github.event.commits.*.message), '[skip-ci]') }}
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
@@ -218,7 +222,7 @@ jobs:
     name: Rustdoc, Formatting and Clippy
     runs-on: ubuntu-latest
     timeout-minutes: 10
-    if: "! contains(toJSON(github.event.commits.*.message), '[skip-ci]')"
+    if: ${{ ! contains(toJSON(github.event.commits.*.message), '[skip-ci]') }}
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4

.gitignore

@@ -4,5 +4,5 @@
 *.iml
 .idea/
 .vscode
+/**/*.ignoreme
 **/output.log
-