|
1 | | -There is a release script at `dev-bin/release.sh` that will do the full |
2 | | -release, including updating the GitHub Pages site. |
3 | | - |
4 | | -This script reads the VERSION number from `CHANGELOG.md`, which you should |
5 | | -have updated to contain the new version number and today's date. After |
6 | | -uploading with this script, you will need to perform the release on the |
7 | | -[Sonatype OSS site](https://oss.sonatype.org/index.html). |
8 | | - |
9 | | -We release to the Maven Central Repository through Sonatype OSSRH. They |
10 | | -provide [detailed directions](https://central.sonatype.org/pages/apache-maven.html) |
11 | | -on the steps of the release or snapshot release process. |
12 | | - |
13 | | -All releases should follow [Semantic Versioning](https://semver.org/). |
14 | | - |
15 | | -Steps for releasing: |
16 | | - |
17 | | -1. Review open issues and PRs to see if any can easily be fixed, closed, or |
18 | | - merged. |
19 | | -2. Bump copyright year in `README.md`, if necessary. |
20 | | - * You do not need to update the version. The release script will do so. |
21 | | -3. Review `CHANGELOG.md` for completeness and correctness. Update its release |
22 | | - date. Commit it. |
23 | | -4. Install or update [gh](https://github.com/cli/cli) as it used by the release script. |
24 | | -5. Test that `mvn package` can complete successfully. Run `git clean -dxff` |
25 | | - or something similar to clean up afterwards. |
26 | | -6. Run `./dev-bin/release.sh`. |
27 | | - * This will package the release, update the gh-pages branch, bump the |
28 | | - version to the next development release, upload the release to GitHub |
29 | | - and tag it, and upload to Sonatype. |
30 | | - * It may prompt you about out of date dependencies. You should consider |
31 | | - updating them if appropriate. Say no and review the changes and upate |
32 | | - `pom.xml` and start the release process over again if you do. |
33 | | -7. The `nexus-staging-maven-plugin` will automatically promote the release on Sonatype. |
34 | | - |
35 | | -There is more information in the |
36 | | -[minfraud-api-java](https://github.com/maxmind/minfraud-api-java/blob/main/README.dev.md) |
37 | | -`README.dev.md` about doing a Java release, including setting up your |
38 | | -environment and completing the release on Sonatype. |
| 1 | +See the [`README.dev.md` in `minfraud-api-java`](https://github.com/maxmind/minfraud-api-java/blob/main/README.dev.md). |
0 commit comments