Bump version to 1.6.1

* improve break handling
* reconfigure local search
* apply minor refactoring
* add github action for audit

.github/workflows/audit.yaml

@@ -6,7 +6,7 @@ on:
       - '**/Cargo.toml'
       - '**/Cargo.lock'
 jobs:
-  security_audit:
+  security-audit:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1

CHANGELOG.md

@@ -0,0 +1,70 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [v1.6.1] - 2020-10-15
+
+### Added
+
+- `breaks` property in `minimize-unassigned` objective
+- dependencies audit by `github actions`
+
+### Changed
+
+- break assignment is made less strict by default. User has certain control on its assignment by the objective.
+- replaced `uniform_real(0., 1.)` usage with `is_hit` method in `Random` trait
+- default parameters of local search operators
+
+### Fixed
+
+- minor tech debt
+
+
+## [v1.6.0] - 2020-10-14
+
+### Added
+
+- cargo features to build `cli` library without certain dependencies
+- proper `k-regret` recreate method
+- `recreate-with-perturbation` recreate method
+- add `local search` operators to ruin recreate mutation:
+    - inter route best
+    - inter route random
+    - intra route random
+
+### Changed
+
+- renamed regret to `skip-best` method
+
+### Fixed
+
+- some issues in init readers
+
+
+## [v1.5.0] - 2020-09-07
+
+### Added
+
+- accept location indices for routing matrix
+
+### Changed
+
+- do not generate initial solutions when initial solution supplied
+
+### Fixed
+
+- ruin bug with zero-cost jobs
+- population size performance issue
+- incorrect checker expectations regarding `vehicleId` template
+
+
+## v1.0.0 - 2020-04-09
+
+- Initial public release
+
+[Unreleased]: https://github.com/reinterpretcat/vrp/compare/v1.6.1...HEAD
+[v1.6.1]: https://github.com/reinterpretcat/vrp/compare/v1.6.0...v1.6.1
+[v1.6.0]: https://github.com/reinterpretcat/vrp/compare/v1.5.0...v1.6.0
+[v1.5.0]: https://github.com/reinterpretcat/vrp/compare/v1.0.0...v1.5.0

README.md

@@ -35,7 +35,7 @@ The fastest way to get vrp solver on your environment is to use `docker` image:
 * **run public image** from `Github Container Registry`:
 
 ```bash
-    docker run -it -v $(pwd):/repo --name vrp-cli --rm ghcr.io/reinterpretcat/vrp/vrp-cli:1.6.0
+    docker run -it -v $(pwd):/repo --name vrp-cli --rm ghcr.io/reinterpretcat/vrp/vrp-cli:1.6.1
 ```
 
 * **build image locally** using `Dockerfile` provided:

docs/src/getting-started/installation.md

@@ -5,7 +5,7 @@
 The fastest way to get vrp solver on your environment is to use public `docker` image from `Github Container Registry`:
 
 ```bash
-    docker run -it -v $(pwd):/repo --name vrp-cli --rm ghcr.io/reinterpretcat/vrp/vrp-cli:1.6.0
+    docker run -it -v $(pwd):/repo --name vrp-cli --rm ghcr.io/reinterpretcat/vrp/vrp-cli:1.6.1
 ```
 
 ## Install from source

examples/json-pragmatic/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "json-pragmatic"
-version = "1.6.0"
+version = "1.6.1"
 authors = ["Ilya Builuk <[email protected]>"]
 license = "Apache-2.0"
 keywords = ["vrp", "optimization"]
@@ -13,7 +13,7 @@ description = "An examples for solving rich VRP"
 publish = false
 
 [dependencies]
-vrp-pragmatic = { path = "../../vrp-pragmatic", version = "1.6.0" }
+vrp-pragmatic = { path = "../../vrp-pragmatic", version = "1.6.1" }
 
 [dev-dependencies]
 criterion = "0.3.3"

vrp-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vrp-cli"
-version = "1.6.0"
+version = "1.6.1"
 authors = ["Ilya Builuk <[email protected]>"]
 license = "Apache-2.0"
 keywords = ["vrp", "optimization"]
@@ -23,9 +23,9 @@ name = "vrp_cli"
 crate-type = ["cdylib", "lib"]
 
 [dependencies]
-vrp-core = { path = "../vrp-core", version = "1.6.0" }
-vrp-scientific = { path = "../vrp-scientific", version = "1.6.0", optional = true }
-vrp-pragmatic = { path = "../vrp-pragmatic", version = "1.6.0" }
+vrp-core = { path = "../vrp-core", version = "1.6.1" }
+vrp-scientific = { path = "../vrp-scientific", version = "1.6.1", optional = true }
+vrp-pragmatic = { path = "../vrp-pragmatic", version = "1.6.1" }
 
 csv = { version = "1.1.3", optional = true }
 serde_json = "1.0.59"

vrp-core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vrp-core"
-version = "1.6.0"
+version = "1.6.1"
 authors = ["Ilya Builuk <[email protected]>"]
 license = "Apache-2.0"
 keywords = ["vrp", "optimization"]

vrp-pragmatic/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vrp-pragmatic"
-version = "1.6.0"
+version = "1.6.1"
 authors = ["Ilya Builuk <[email protected]>"]
 license = "Apache-2.0"
 keywords = ["vrp", "optimization"]
@@ -12,7 +12,7 @@ edition = "2018"
 description = "An extension logic for solving rich VRP"
 
 [dependencies]
-vrp-core = { path = "../vrp-core", version = "1.6.0" }
+vrp-core = { path = "../vrp-core", version = "1.6.1" }
 
 serde = { version = "1.0.116", features = ["derive"] }
 serde_json = "1.0.59"

vrp-scientific/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vrp-scientific"
-version = "1.6.0"
+version = "1.6.1"
 authors = ["Ilya Builuk <[email protected]>"]
 license = "Apache-2.0"
 keywords = ["vrp", "optimization"]
@@ -13,4 +13,4 @@ description = "An extension logic for solving scientific VRP"
 
 
 [dependencies]
-vrp-core = { path = "../vrp-core", version = "1.6.0" }
+vrp-core = { path = "../vrp-core", version = "1.6.1" }