Skip to content

Prepare major release 6.0.0 #418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,26 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased] - 2024-06-10
## [Unreleased] - 2024-07-25

**Breaking Changes**: Due to breaking changes, the next release will be a major release (see the Removed section below for details). Timing of that major release will likely be in the Fall of 2024 to coincide with the planned transition to Java 21.
### Added

### Changed

### Deprecated

### Removed

### Fixed

### Dependencies

### CI/CD

### Other


## [6.0.0] - 2024-07-25

### Added
* SequenceSampler.getDefault() method for creating an instance of the default implementation of SequenceSampler.
Expand All @@ -23,8 +40,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* Refactored to improve code quality and to optimize SequenceReservoirSampler, SequencePoolSampler, SequenceInsertionSampler, SequenceCompositeSampler.
* Minor optimizations to Permutation.scramble() methods.

### Deprecated

### Removed
* Removed the previously deprecated (in v5.1.0) constructor `org.cicirello.sequences.distance.EditDistance(double, double, double)`. To compute edit distance with double-valued costs for arrays and other sequences, use the existing `EditDistanceDouble` class instead. This does not impact the class with the same name that computes edit distance for permutations (i.e., the `org.cicirello.permutations.distance.EditDistance` class still accepts doubles for the costs).
* Removed default method implementations in SequenceSampler interface (all interface methods now implemented in the implementing classes).
Expand All @@ -44,8 +59,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* Integrated Find Security Bugs static analysis into build process.
* Discontinued publication of a `jar-with-dependencies` (BREAKING CHANGE only if you were using the fat jar).

### Other


## [5.1.0] - 2023-05-30

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ and minimum supported Java version.

| version | Java requirements |
| --- | --- |
| 4.w.x to 5.y.z | Java 17+ |
| 4.w.x to 6.y.z | Java 17+ |
| 3.x.y | Java 11+ |
| 1.x.y to 2.x.y | Java 8+ |
| 1.w.x to 2.y.z | Java 8+ |

The jar files of the library are released via Maven Central, GitHub Packages,
and GitHub Releases.
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>org.cicirello</groupId>
<artifactId>jpt</artifactId>
<version>5-SNAPSHOT</version>
<version>6-SNAPSHOT</version>
<packaging>jar</packaging>

<name>JavaPermutationTools</name>
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/module-info.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* JavaPermutationTools - A Java library for computation on permutations.
* Copyright 2005-2023 Vincent A. Cicirello, <https://www.cicirello.org/>.
* Copyright 2005-2024 Vincent A. Cicirello, <https://www.cicirello.org/>.
*
* JavaPermutationTools is free software: you can
* redistribute it and/or modify it under the terms of the GNU
Expand All @@ -24,7 +24,7 @@
*
* <h2>JavaPermutationTools - A Java library for computation on permutations</h2>
*
* <p>Copyright &copy; 2005-2023 <a href="https://www.cicirello.org/" target=_top>Vincent A.
* <p>Copyright &copy; 2005-2024 <a href="https://www.cicirello.org/" target=_top>Vincent A.
* Cicirello</a>.
*
* <p><a href="https://doi.org/10.21105/joss.00950"><img
Expand Down