Author: aherbert
Date: Mon Oct 10 12:44:27 2022
New Revision: 1080995
Log:
Simplify release description in the changes report
Modified:
websites/production/commons/content/proper/commons-rng/changes-report.html
websites/production/commons/content/proper/commons-rng/developers.html
Modified:
websites/production/commons/content/proper/commons-rng/changes-report.html
==============================================================================
--- websites/production/commons/content/proper/commons-rng/changes-report.html
(original)
+++ websites/production/commons/content/proper/commons-rng/changes-report.html
Mon Oct 10 12:44:27 2022
@@ -263,27 +263,27 @@
<tr class="b">
<td><a href="#a1.5">1.5</a></td>
<td>2022-09-10</td>
-<td>This is a minor release of Apache Commons RNG, containing a few new
features and performance improvements. Apache Commons RNG 1.5 contains the
following library modules: commons-rng-client-api (requires Java 8)
commons-rng-core (requires Java 8) commons-rng-simple (requires Java 8)
commons-rng-sampling (requires Java 8) The code in module 'commons-rng-core'
should not be accessed directly by applications as a future release might make
use of the JPMS modularization feature available in Java 11+. Additional code
is provided in the following modules: commons-rng-examples-quadrature
(requires Java 8) commons-rng-examples-jmh (requires Java 8)
commons-rng-examples-sampling (requires Java 8) commons-rng-examples-stress
(requires Java 8) commons-rng-examples-jpms (requires Java 11) It is however
not part of the official API and no compatibility should be expected in
subsequent releases. It must be noted that, due to the nature of random number
generation, some unit
tests are bound to fail with some probability. The 'maven-surefire-plugin'
is configured to re-run tests that fail, and pass the build if they succeed
within the allotted number of reruns (the test will be marked as 'flaky' in the
report). The source output type (int/long) of a RNG must maintain behavioural
compatibility between releases; derived types may break behavioural
compatibility. Any functional changes will be recorded in the release
notes.</td></tr>
+<td>New features, updates and bug fixes. Adds a commons-rng-bom module.
Requires Java 8.</td></tr>
<tr class="a">
<td><a href="#a1.4">1.4</a></td>
<td>2021-09-13</td>
-<td>This is a minor release of Apache Commons RNG, containing a few new
features and performance improvements. Apache Commons RNG 1.4 contains the
following library modules: commons-rng-client-api (requires Java 8)
commons-rng-core (requires Java 8) commons-rng-simple (requires Java 8)
commons-rng-sampling (requires Java 8) The code in module 'commons-rng-core'
should not be accessed directly by applications as a future release might make
use of the JPMS modularization feature available in Java 11+. Additional code
is provided in the following modules: commons-rng-examples-quadrature
(requires Java 8) commons-rng-examples-jmh (requires Java 8)
commons-rng-examples-sampling (requires Java 8) commons-rng-examples-stress
(requires Java 8) commons-rng-examples-jpms (requires Java 11) It is however
not part of the official API and no compatibility should be expected in
subsequent releases. It must be noted that, due to the nature of random number
generation, some unit
tests are bound to fail with some probability. The 'maven-surefire-plugin'
is configured to re-run tests that fail, and pass the build if they succeed
within the allotted number of reruns (the test will be marked as 'flaky' in the
report).</td></tr>
+<td>New features, updates and bug fixes. Updates the minimum Java version to
8.</td></tr>
<tr class="b">
<td><a href="#a1.3">1.3</a></td>
<td>2019-11-08</td>
-<td>This is a minor release of Apache Commons RNG, containing a few new
features and performance improvements. Apache Commons RNG 1.3 contains the
following library modules: commons-rng-client-api (requires Java 6)
commons-rng-core (requires Java 6) commons-rng-simple (requires Java 6)
commons-rng-sampling (requires Java 6) The code in module 'commons-rng-core'
should not be accessed directly by applications as a future release might make
use of the JPMS modularization feature available in Java 9+. Additional code
is provided in the following module: commons-rng-examples (requires Java 9)
It is however not part of the official API and no compatibility should be
expected in subsequent releases. It must be noted that, due to the nature of
random number generation, some of unit tests are bound to fail with some
probability. The 'maven-surefire-plugin' is configured to re-run tests that
fail, and pass the build if they succeed within the allotted number of reruns
(the test
will be marked as 'flaky' in the report).</td></tr>
+<td>New features, updates and bug fixes (requires Java 6).</td></tr>
<tr class="a">
<td><a href="#a1.2">1.2</a></td>
<td>2018-12-12</td>
-<td>This is a minor release of Apache Commons RNG, containing a few new
features and performance improvements. Apache Commons RNG 1.2 contains the
following library modules: commons-rng-client-api (requires Java 6)
commons-rng-core (requires Java 6) commons-rng-simple (requires Java 6)
commons-rng-sampling (requires Java 6) The code in module 'commons-rng-core'
should not be accessed directly by applications as a future release might make
use of the JPMS modularization feature available in Java 9+. Additional code
is provided in the following module: commons-rng-examples (requires Java 9)
It is however not part of the official API and no compatibility should be
expected in subsequent releases. It must be noted that, due to the nature of
random number generation, some of unit tests are bound to fail with some
probability. The 'maven-surefire-plugin' is configured to re-run tests that
fail, and pass the build if they succeed within the allotted number of reruns
(the test
will be marked as 'flaky' in the report).</td></tr>
+<td>New features, updates and bug fixes (requires Java 6).</td></tr>
<tr class="b">
<td><a href="#a1.1">1.1</a></td>
<td>2018-08-14</td>
-<td>This is a minor release of Apache Commons RNG, containing a few new
features and performance improvements. Apache Commons RNG 1.1 contains the
following library modules: commons-rng-client-api (requires Java 6)
commons-rng-core (requires Java 6) commons-rng-simple (requires Java 6)
commons-rng-sampling (requires Java 6) The code in module 'commons-rng-core'
should not be accessed directly by applications as a future release might make
use of the JPMS modularization feature available in Java 9+. Additional code
is provided in the following module: commons-rng-examples (requires Java 9)
It is however not part of the official API and no compatibility should be
expected in subsequent releases. We would like to also note that unit tests in
module 'commons-rng-sampling' are bound to fail with some probability; this is
expected due to the nature of random number generation. The
'maven-surefire-plugin' can be configured to re-run tests that fail and pass
the build if they
succeed (the test will be marked as 'flaky' in the report).</td></tr>
+<td>New features, updates and bug fixes (requires Java 6).</td></tr>
<tr class="a">
<td><a href="#a1.0">1.0</a></td>
<td>2016-12-13</td>
-<td>This is the first release of Apache Commons RNG. Apache Commons RNG 1.0
contains the following modules: commons-rng-client-api (requires Java 6)
commons-rng-core (requires Java 6) commons-rng-simple (requires Java 6)
commons-rng-sampling (requires Java 6) commons-rng-jmh (requires Java 6)
commons-rng-examples (requires Java 7)</td></tr></table></section><section>
+<td>This is the first release of Apache Commons RNG. Contains the following
modules: commons-rng-client-api; commons-rng-core; commons-rng-simple;
commons-rng-sampling. Requires Java 6.</td></tr></table></section><section>
<h3 id="a1.5">Release 1.5 – 2022-09-10</h3>
<table border="0" class="bodyTable">
<tr class="b">
Modified: websites/production/commons/content/proper/commons-rng/developers.html
==============================================================================
--- websites/production/commons/content/proper/commons-rng/developers.html
(original)
+++ websites/production/commons/content/proper/commons-rng/developers.html Mon
Oct 10 12:44:27 2022
@@ -495,6 +495,16 @@
expected.
</li>
</ul>
+
+<p>
+ It must be noted that, due to the nature of random number
generation, some unit tests
+ are bound to fail with some probability. This is applicable for
tests that compare
+ random output to an expected distribution. These tests <i>should</i>
<b>not</b>
+ use a fixed seed to ensure consistent output. The
'maven-surefire-plugin' is configured to
+ re-run tests that fail, and pass the build if they succeed within
the allotted number of
+ reruns (the test will be marked as 'flaky' in the report). Any test
that is consistently
+ 'flaky' may require an update to the test assumptions and assertions.
+ </p>
</section>
<section>
<h3><a name="Licensing_and_copyright"></a>Licensing and copyright</h3>
