Merge pull request #29 from Decompollaborate/develop

2.5.0

.github/workflows/publish_crate.yml

@@ -22,7 +22,7 @@ jobs:
       run: cargo fmt --check
 
   check_clippy:
-    name: Check clippy
+    name: Check clippy: no features
     runs-on: ubuntu-latest
 
     steps:
@@ -41,6 +41,46 @@ jobs:
     - name: Run clippy
       run: cargo clippy --all-targets -- -D warnings
 
+  check_clippy_serde:
+    name: Check clippy: features: serde
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout reposistory
+      uses: actions/checkout@v4
+
+    - name: Setup Rust toolchain
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        override: true
+
+    - name: Setup clippy
+      run: rustup component add clippy
+
+    - name: Run clippy
+      run: cargo clippy --all-targets --features serde -- -D warnings
+
+  check_clippy_all_features:
+    name: Check clippy: features: all
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout reposistory
+      uses: actions/checkout@v4
+
+    - name: Setup Rust toolchain
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        override: true
+
+    - name: Setup clippy
+      run: rustup component add clippy
+
+    - name: Run clippy
+      run: cargo clippy --all-targets --all-features -- -D warnings
+
   run_tests:
     name: Run tests
     runs-on: ubuntu-latest
@@ -58,6 +98,19 @@ jobs:
     - name: Run tests
       run: cargo test --workspace
 
+  msrv:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout reposistory
+        uses: actions/checkout@v4
+
+      - name: Setup MSRV checker
+        uses: taiki-e/install-action@cargo-hack
+
+      - name: Run MSRV checker
+        run: cargo hack check --rust-version --workspace --all-targets --ignore-private
+
+
   publish:
     name: Publish
     runs-on: ubuntu-latest

.gitignore

@@ -170,4 +170,3 @@ cython_debug/
 # Added by cargo
 
 /target
-/Cargo.lock

CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.5.0] - 2024-08-09
+
+### Added
+
+- Add Minimal Supported Rust Version (MSRV) to Cargo.toml.
+- Add `MapFile::new_from_map_file` function to simplify `MapFile` creation.
+- Add `serde` feature to the Rust crate.
+  - Allows serializing and deserializing a `MapFile` object using serde.
+
+### Changed
+
+- Tweak symbol comparison logic a bit.
+  - Symbol shifting (due to different sizes or extra/missing symbols) should
+    not affect comparing non shifted files.
+- `Cargo.lock` file is now committed to the repo.
+- Change Rust functions to properly take references instead of consuming the
+  argument.
+
+### Fixed
+
+- Fix `MapFile::find_lowest_differing_symbol` not returning a previous symbol
+  from a previous file if the symbol found is the first symbol from the file.
+
 ## [2.4.0] - 2024-03-25
 
 ### Added
@@ -343,6 +366,7 @@ Full changes: <https://github.com/Decompollaborate/mapfile_parser/compare/702a73
 - Initial release
 
 [unreleased]: https://github.com/Decompollaborate/mapfile_parser/compare/master...develop
+[2.5.0]: https://github.com/Decompollaborate/mapfile_parser/compare/2.4.0...2.5.0
 [2.4.0]: https://github.com/Decompollaborate/mapfile_parser/compare/2.3.7...2.4.0
 [2.3.7]: https://github.com/Decompollaborate/mapfile_parser/compare/2.3.6...2.3.7
 [2.3.6]: https://github.com/Decompollaborate/mapfile_parser/compare/2.3.5...2.3.6