Skip to content

Commit 31f07b8

Browse files
Marcono1234eamonnmcmanus
authored andcommitted
Mention creation of GitHub release in ReleaseProcess.md (#2349)
* Mention creation of GitHub release in `ReleaseProcess.md` * Link to GitHub releases from README
1 parent f0e7dc0 commit 31f07b8

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ see [`GsonBuilder.disableJdkUnsafe()`](https://javadoc.io/doc/com.google.code.gs
5959
* [API Javadoc](https://www.javadoc.io/doc/com.google.code.gson/gson): Documentation for the current release
6060
* [User guide](UserGuide.md): This guide contains examples on how to use Gson in your code
6161
* [Troubleshooting guide](Troubleshooting.md): Describes how to solve common issues when using Gson
62-
* [Change log](CHANGELOG.md): Changes in the recent versions
62+
* [Releases and change log](https://github.com/google/gson/releases): Latest releases and changes in these versions; for older releases see [`CHANGELOG.md`](CHANGELOG.md)
6363
* [Design document](GsonDesignDocument.md): This document discusses issues we faced while designing Gson. It also includes a comparison of Gson with other Java libraries that can be used for Json conversion
6464

6565
Please use the ['gson' tag on StackOverflow](https://stackoverflow.com/questions/tagged/gson) or the [google-gson Google group](https://groups.google.com/group/google-gson) to discuss Gson or to post questions.

ReleaseProcess.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The following is a step-by-step procedure for releasing a new version of Google-
1313
1. [Log in to Nexus repository manager](https://oss.sonatype.org/index.html#welcome) at Sonatype and close the staging repository for Gson.
1414
1. Download and sanity check all downloads. Do not skip this step! Once you release the staging repository, there is no going back. It will get synced with Maven Central and you will not be able to update or delete anything. Your only recourse will be to release a new version of Gson and hope that no one uses the old one.
1515
1. Release the staging repository for Gson. Gson will now get synced to Maven Central with-in the next hour. For issues consult [Sonatype Guide](https://central.sonatype.org/publish/release/).
16-
1. Update [Gson Changelog](CHANGELOG.md). Also, look at all bugs that were fixed and add a few lines describing what changed in the release.
16+
1. Create a [GitHub release](https://github.com/google/gson/releases) for the new version. You can let GitHub [automatically generate the description for the release](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes), but you should edit it manually to point out the most important changes and potentially incompatible changes.
1717
1. Update version references in (version might be referenced multiple times):
1818
- [`README.md`](README.md)
1919
- [`UserGuide.md`](UserGuide.md)

0 commit comments

Comments
 (0)