2.5.0 Release documentation. (#1657)

Author: bodiam

README.md

@@ -29,20 +29,20 @@ In the pom.xml, add the following fragment to the `dependencies` section:
 <dependency>
     <groupId>net.datafaker</groupId>
     <artifactId>datafaker</artifactId>
-    <version>2.4.4</version>
+    <version>2.5.0</version>
 </dependency>
 ```
 
 For Gradle users, add the following to your build.gradle file.
 
 ```groovy
 dependencies {
-    implementation 'net.datafaker:datafaker:2.4.4'
+    implementation 'net.datafaker:datafaker:2.5.0'
 }
 
 ```
 
-You can also use the snapshot version (`2.4.5-SNAPSHOT`), which automatically gets published
+You can also use the snapshot version (`2.5.1-SNAPSHOT`), which automatically gets published
 after every push to the main branch of this repository. Binary repository URL for snapshots download is
 `https://s01.oss.sonatype.org/content/repositories/snapshots/`.
 

docs/documentation/providers.md

@@ -31,8 +31,9 @@ Number of providers per Datafaker version
 | 2.3.0   | 9                       | 247                       |
 | 2.4.0   | 3                       | 250                       |
 | 2.4.4   | 2                       | 252                       |
+| 2.5.0   | 1                       | 253                       |
 
-Datafaker comes with a total of 252 data providers:
+Datafaker comes with a total of 253 data providers:
 
 | Name                                                                                                                                                            | Description                                                                                                                                                                                                 | Group         | Since |
 |-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-------|
@@ -91,6 +92,7 @@ Datafaker comes with a total of 252 data providers:
 | [Cosmere](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Cosmere.html)                                                      | The cosmere is a fictional shared universe where several of Brandon Sanderson's books take place.                                                                                                           | Base          | 1.7.0 |
 | [Country](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Country.html)                                                      |                                                                                                                                                                                                             | Base          | 0.8.0 |
 | [Cowboy Bebop](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/entertainment/CowboyBebop.html)                                    | Cowboy Bebop is a Japanese neo-noir science fiction anime television series, which originally ran from 1998 to 1999.                                                                                        | Entertainment | 1.8.0 |
+| [Credentials](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/Credentials.html)                                              | Generates credentials such as usernames, uids and passwords.                                                                                                                                                | Base          | 2.5.0 |
 | [Cricket](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/sport/Cricket.html)                                                     |                                                                                                                                                                                                             | Sport         | 1.7.0 |
 | [Crypto Coin](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/CryptoCoin.html)                                               |                                                                                                                                                                                                             | Base          | 1.3.0 |
 | [Culture Series](https://javadoc.io/doc/net.datafaker/datafaker/latest/net/datafaker/providers/base/CultureSeries.html)                                         | The Culture series is a science fiction series written by Scottish author Iain M. Banks and released from 1987 through to 2012.                                                                             | Base          | 1.7.0 |

docs/releases/2.5.0.md

@@ -0,0 +1,46 @@
+# Datafaker 2.5.0 (16-09-2025)
+
+## What's Changed
+
+* Updated release documentation and set autopublish while publishing to… by @bodiam in https://github.com/datafaker-net/datafaker/pull/1588
+* Add some new titles to the Zelda game list by @yuokada in https://github.com/datafaker-net/datafaker/pull/1589
+* Fix Singapore ID number generation by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1594
+* Removing parent, not sure if still needed. by @bodiam in https://github.com/datafaker-net/datafaker/pull/1600
+* [build] Use jdk25-ea in CI by @snuyanzin in https://github.com/datafaker-net/datafaker/pull/1601
+* Refactor tests extending `BaseFakerTest` by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1606
+* Refactor BaseFakerTest (provider list test) by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1607
+* Fix csv generate by limit by @abudevich in https://github.com/datafaker-net/datafaker/pull/1615
+* Avoid useless `NoSuchMethodRuntimeException` in logs by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1620
+* Remove duplicates in "*.yml" files by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1608
+* Fix flaky test WeightedRandomSelectorTest by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1626
+* Fixed toLocalPart; Fixed tests; Fixed formatting by @rcriosbr in https://github.com/datafaker-net/datafaker/pull/1624
+* Creates new Credential provider; Deprecated Internet provider methods by @rcriosbr in https://github.com/datafaker-net/datafaker/pull/1628
+* Renamed Credential to Credentials by @bodiam in https://github.com/datafaker-net/datafaker/pull/1630
+* make Brazilian ID Number accessible via `faker.idNumber()` by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1631
+* Removed System.out.printlns and other useless bits. by @bodiam in https://github.com/datafaker-net/datafaker/pull/1632
+* Fix Correct typo in kpop.boy_bands key in ko.yml by @Chanwon-Seo in https://github.com/datafaker-net/datafaker/pull/1635
+* Feat Improve Korean name data in ko.yml by @Chanwon-Seo in https://github.com/datafaker-net/datafaker/pull/1636
+* Update CreditCard formats in Finance provider by @Fishbowler in https://github.com/datafaker-net/datafaker/pull/1637
+* Finance Provider - update Swift IBAN data standard from v87 to v99 by @Fishbowler in https://github.com/datafaker-net/datafaker/pull/1641
+* Add missing javadoc for the Finance provider by @Fishbowler in https://github.com/datafaker-net/datafaker/pull/1640
+* Add Starships to the Star Trek provider by @Fishbowler in https://github.com/datafaker-net/datafaker/pull/1642
+* Make Finance provider's UnionPay test more readable, especially on failure by @Fishbowler in https://github.com/datafaker-net/datafaker/pull/1643
+* Make "as" message more informative in few tests by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1644
+* Fewer logs in tests by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1646
+* Corrected typos in ko.yml by @momoysm in https://github.com/datafaker-net/datafaker/pull/1645
+* Add methods to generate random port within given range by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1651
+* Remove unneeded test `testNoDuplications` by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1652
+* Refactoring: eliminate recursive provider calls by @asolntsev in https://github.com/datafaker-net/datafaker/pull/1650
+
+## New Contributors
+* @abudevich made their first contribution in https://github.com/datafaker-net/datafaker/pull/1615
+* @rcriosbr made their first contribution in https://github.com/datafaker-net/datafaker/pull/1624
+* @Chanwon-Seo made their first contribution in https://github.com/datafaker-net/datafaker/pull/1635
+* @Fishbowler made their first contribution in https://github.com/datafaker-net/datafaker/pull/1637
+* @momoysm made their first contribution in https://github.com/datafaker-net/datafaker/pull/1645
+
+**Full Changelog**: https://github.com/datafaker-net/datafaker/compare/2.4.4...2.5.0
+
+## Providers added
+
+See https://www.datafaker.net/documentation/providers/

docs/releases/2.5.0-SNAPSHOT.md docs/releases/2.5.1-SNAPSHOT.mddocs/releases/2.5.0-SNAPSHOT.md renamed to docs/releases/2.5.1-SNAPSHOT.md

@@ -1,4 +1,4 @@
-# Datafaker 2.5.0 (07-04-2025)
+# Datafaker 2.5.1-SNAPSHOT (TBD)
 
 ## What's Changed
 

mkdocs.yml

@@ -80,8 +80,8 @@ plugins:
 # Customization
 extra:
   datafaker:
-    version: 2.4.4
-    snapshot: 2.4-5-SNAPSHOT
+    version: 2.5.0
+    snapshot: 2.5.1-SNAPSHOT
 
 # Page tree
 nav:
@@ -103,15 +103,16 @@ nav:
     - Performance:
       - Datafaker 1.4.0: documentation/performance140.md
       - Datafaker 1.7.0: documentation/performance170.md
-    - Javadoc: 'https://s01.oss.sonatype.org/service/local/repositories/releases/archive/net/datafaker/datafaker/2.4.4/datafaker-2.4.4-javadoc.jar/!/index.html'
+    - Javadoc: 'https://s01.oss.sonatype.org/service/local/repositories/releases/archive/net/datafaker/datafaker/2.5.0/datafaker-2.5.0-javadoc.jar/!/index.html'
     - Contributing: documentation/contributing.md
     - First time contributor: documentation/first-time-contributor.md
     - License: documentation/license.md
 #    - Changelog:
 #      - Changes: changelog/index.md
 #      - How to upgrade: upgrade.md
   - Releases:
-    - 2.5.0-SNAPSHOT: releases/2.5.0-SNAPSHOT.md
+    - 2.5.1-SNAPSHOT: releases/2.5.1-SNAPSHOT.md
+    - 2.5.0: releases/2.5.0.md
     - 2.4.4: releases/2.4.4.md
     - 2.4.3: releases/2.4.3.md
     - 2.4.2: releases/2.4.2.md

pom.xml

@@ -4,7 +4,7 @@
     <groupId>net.datafaker</groupId>
     <artifactId>datafaker</artifactId>
     <packaging>jar</packaging>
-    <version>2.4.5-SNAPSHOT</version>
+    <version>2.5.1-SNAPSHOT</version>
     <name>Datafaker</name>
     <description>
         This library is an improved fork of JavaFaker (as well as Ruby's stympy/faker gem and Perl's Data::Faker