release v0.9.4 (#632)

release v0.9.4

Author: V0ldek

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -71,7 +71,8 @@ body:
   attributes:
     label: Version of the release
     options:
-      # <newest-release=v0.9.3>
+      # <newest-release=v0.9.4>
+      - v0.9.4
       - v0.9.3
       - v0.9.2
       - v0.9.1

.github/workflows/release.yml

@@ -217,8 +217,30 @@ jobs:
         with:
           toolchain: stable
       - name: Publish rsonpath-syntax
-        run: cargo publish --token ${{ secrets.CRATES_TOKEN }} -p rsonpath-syntax --no-verify
+        run: |
+          old_ver=$(cargo info rsonpath-syntax --registry crates-io | sed -n 's/version: \([0-9]\.[0-9].[0-9]\)/\1/p')
+          new_ver=$(cargo pkgid rsonpath-syntax | sed 's/.*#//g')
+          if [ $old_ver != $new_ver ]; then
+            cargo publish --token ${{ secrets.CRATES_TOKEN }} -p rsonpath-syntax --no-verify
+          fi
+      - name: Publish rsonpath-syntax-proptest
+        run: |
+          old_ver=$(cargo info rsonpath-syntax-proptest --registry crates-io | sed -n 's/version: \([0-9]\.[0-9].[0-9]\)/\1/p')
+          new_ver=$(cargo pkgid rsonpath-syntax-proptest | sed 's/.*#//g')
+          if [ $old_ver != $new_ver ]; then
+            cargo publish --token ${{ secrets.CRATES_TOKEN }} -p rsonpath-syntax-proptest --no-verify
+          fi
       - name: Publish rsonpath-lib
-        run: cargo publish --token ${{ secrets.CRATES_TOKEN }} -p rsonpath-lib --no-verify
+        run: |
+          old_ver=$(cargo info rsonpath-lib --registry crates-io | sed -n 's/version: \([0-9]\.[0-9].[0-9]\)/\1/p')
+          new_ver=$(cargo pkgid rsonpath-lib | sed 's/.*#//g')
+          if [ $old_ver != $new_ver ]; then
+            cargo publish --token ${{ secrets.CRATES_TOKEN }} -p rsonpath-lib --no-verify
+          fi
       - name: Publish rsonpath
-        run: cargo publish --token ${{ secrets.CRATES_TOKEN }} -p rsonpath --no-verify
+        run: |
+          old_ver=$(cargo info rsonpath --registry crates-io | sed -n 's/version: \([0-9]\.[0-9].[0-9]\)/\1/p')
+          new_ver=$(cargo pkgid rsonpath | sed 's/.*#//g')
+          if [ $old_ver != $new_ver ]; then
+            cargo publish --token ${{ secrets.CRATES_TOKEN }} -p rsonpath --no-verify
+          fi

CHANGELOG.md

@@ -2,6 +2,24 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.9.4] - 2024-12-31
+
+### Library
+
+- Serde support for `MainEngine`.
+  - Implemented `serde::Serialize` and `serde::Deserialize` for `MainEngine` in rsonpath-lib,
+    The `serde` dependency is guarded behind the optional `serde` feature.
+  - The serialization format is not stable, as the `Automaton`
+    is expected to evolve. Thus, serialization includes a version
+    and deserialization will fail if the version disagrees.
+  - Also added snapshot tests for serialization based on `insta`.
+- Added the `MainEngine::automaton` function to retrieve a reference to the compiled query.
+- Removed the `arbitrary` feature from `rsonpath-lib` as it didn't actually do anything anymore.
+
+### Dependencies
+
+- `serde` (1.0.217) is now an optional dependency for `rsonpath` and `rsonpath-lib`
+
 ## [0.9.3] - 2024-12-24
 
 ### Library

Cargo.lock

@@ -13,7 +13,7 @@ exclude = ["crates/rsonpath-benchmarks", "crates/rsonpath-test-codegen"]
 resolver = "2"
 
 [workspace.package]
-version = "0.9.3"
+version = "0.9.4"
 authors = ["Mateusz Gienieczko <mat@gienieczko.com>"]
 readme = "README.md"
 license = "MIT"
@@ -23,9 +23,9 @@ edition = "2021"
 
 [workspace.dependencies]
 # Project crates
-rsonpath-lib = { version = "0.9.3", path = "./crates/rsonpath-lib", package = "rsonpath-lib", default-features = false }
-rsonpath-syntax = { version = "0.3.2", path = "./crates/rsonpath-syntax" }
-rsonpath-syntax-proptest = { version = "0.3.2", path = "./crates/rsonpath-syntax-proptest" }
+rsonpath-lib = { version = "0.9.4", path = "./crates/rsonpath-lib", package = "rsonpath-lib", default-features = false }
+rsonpath-syntax = { version = "0.4.0", path = "./crates/rsonpath-syntax" }
+rsonpath-syntax-proptest = { version = "0.4.0", path = "./crates/rsonpath-syntax-proptest" }
 # Main dependencies
 arbitrary = { version = "1.4.1" }
 cfg-if = "1.0.0"

Cargo.toml

@@ -273,24 +273,25 @@ release ver:
     just release-patch {{ver}}
     just release-readme
     just release-bug-template {{ver}}
-    cargo build
-    cargo +nightly fuzz build
 
 # Execute prerequisites for a release of `rsonpath-syntax` for the given version.
 release-syntax ver:
     #!/usr/bin/env nu
     let ver = "{{ver}}";
     sed -i $'s/^version = "[^"]*"/version = "($ver)"/' "./crates/rsonpath-syntax/Cargo.toml"
+    sed -i $'s/^version = "[^"]*"/version = "($ver)"/' "./crates/rsonpath-syntax-proptest/Cargo.toml"
     sed -i $'s/^rsonpath-syntax = { version = "[^"]*"/rsonpath-syntax = { version = "($ver)"/' "./Cargo.toml"
+    sed -i $'s/^rsonpath-syntax-proptest = { version = "[^"]*"/rsonpath-syntax-proptest = { version = "($ver)"/' "./Cargo.toml"
 
 [private]
-release-patch ver:
+release-main ver:
     #!/usr/bin/env nu
     let ver = "{{ver}}";
     let paths = ["./Cargo.toml", "./crates/rsonpath-benchmarks/Cargo.toml", "./crates/rsonpath-test-codegen/Cargo.toml"];
     $paths | each { |path|
         sed -i $'s/^version = "[^"]*"/version = "($ver)"/;s/^rsonpath-lib = { version = "[^"]*"/rsonpath-lib = { version = "($ver)"/;s/rsonpath-test-codegen = { version = "[^"]*"/rsonpath-test-codegen = { version = "($ver)"/' $path;
     };
+    sed -z -i $"s/\\$ rq -V\\nrq \\\([^\\n]*\\\)\\n/\\$ rq -V\\nrq ($ver)\\n/" ./book/src/user/installation.md
 
 [private]
 release-readme: