Skip to content

Commit 4f948dd

Browse files
Marcono1234Marcono1234
authored
Automatically replace version references on release:prepare (#2212)
* Automatically replace version references on `release:prepare` * Specify encoding and improve placeholder replacements * Add `since $next-version$` for `JsonArray.asList` and `JsonObject.asMap`
1 parent 9578583 commit 4f948dd

5 files changed

Lines changed: 82 additions & 2 deletions

File tree

‎ReleaseProcess.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ The following is a step-by-step procedure for releasing a new version of Google-
66
1. Ensure all changelists are code-reviewed and have +1
77
1. `cd gson` to the parent directory; ensure there are no open files and all changes are committed.
88
1. Run `mvn release:clean`
9-
1. Do a dry run: `mvn release:prepare -DdryRun=true`
109
1. Start the release: `mvn release:prepare`
1110
- Answer questions: usually the defaults are fine. Try to follow [Semantic Versioning](https://semver.org/) when choosing the release version number.
1211
- This will do a full build, change version from `-SNAPSHOT` to the released version, commit and create the tags. It will then change the version to `-SNAPSHOT` for the next release.
@@ -18,9 +17,13 @@ The following is a step-by-step procedure for releasing a new version of Google-
1817
1. Update version references in (version might be referenced multiple times):
1918
- [`README.md`](README.md)
2019
- [`UserGuide.md`](UserGuide.md)
20+
21+
Note: When using the Maven Release Plugin as described above, these version references should have been replaced automatically, but verify this manually nonetheless to be on the safe side.
2122
1. Optional: Create a post on the [Gson Discussion Forum](https://groups.google.com/group/google-gson).
2223
1. Optional: Update the release version in [Wikipedia](https://en.wikipedia.org/wiki/Gson) and update the current "stable" release.
2324

25+
Important: When aborting a release / rolling back release preparations, make sure to also revert all changes to files which were done during the release (e.g. automatic replacement of version references).
26+
2427
## Configuring a machine for deployment to Sonatype Repository
2528

2629
This section was borrowed heavily from [Doclava release process](https://code.google.com/archive/p/doclava/wikis/ProcessRelease.wiki).

‎gson/src/main/java/com/google/gson/Gson.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1024,6 +1024,7 @@ public <T> T fromJson(String json, Type typeOfT) throws JsonSyntaxException {
10241024
*
10251025
* @see #fromJson(Reader, TypeToken)
10261026
* @see #fromJson(String, Class)
1027+
* @since $next-version$
10271028
*/
10281029
public <T> T fromJson(String json, TypeToken<T> typeOfT) throws JsonSyntaxException {
10291030
if (json == null) {
@@ -1116,6 +1117,7 @@ public <T> T fromJson(Reader json, Type typeOfT) throws JsonIOException, JsonSyn
11161117
*
11171118
* @see #fromJson(String, TypeToken)
11181119
* @see #fromJson(Reader, Class)
1120+
* @since $next-version$
11191121
*/
11201122
public <T> T fromJson(Reader json, TypeToken<T> typeOfT) throws JsonIOException, JsonSyntaxException {
11211123
JsonReader jsonReader = newJsonReader(json);
@@ -1199,6 +1201,7 @@ public <T> T fromJson(JsonReader reader, Type typeOfT) throws JsonIOException, J
11991201
*
12001202
* @see #fromJson(Reader, TypeToken)
12011203
* @see #fromJson(JsonReader, Type)
1204+
* @since $next-version$
12021205
*/
12031206
public <T> T fromJson(JsonReader reader, TypeToken<T> typeOfT) throws JsonIOException, JsonSyntaxException {
12041207
boolean isEmpty = true;
@@ -1304,10 +1307,10 @@ public <T> T fromJson(JsonElement json, Type typeOfT) throws JsonSyntaxException
13041307
* @return an object of type T from the JSON. Returns {@code null} if {@code json} is {@code null}
13051308
* or if {@code json} is empty.
13061309
* @throws JsonSyntaxException if json is not a valid representation for an object of type typeOfT
1307-
* @since 1.3
13081310
*
13091311
* @see #fromJson(Reader, TypeToken)
13101312
* @see #fromJson(JsonElement, Class)
1313+
* @since $next-version$
13111314
*/
13121315
public <T> T fromJson(JsonElement json, TypeToken<T> typeOfT) throws JsonSyntaxException {
13131316
if (json == null) {

‎gson/src/main/java/com/google/gson/JsonArray.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -406,6 +406,7 @@ public boolean getAsBoolean() {
406406
* Use {@link JsonNull} for JSON null values.
407407
*
408408
* @return mutable {@code List} view
409+
* @since $next-version$
409410
*/
410411
public List<JsonElement> asList() {
411412
return new NonNullElementWrapperList<>(elements);

‎gson/src/main/java/com/google/gson/JsonObject.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,7 @@ public JsonObject getAsJsonObject(String memberName) {
220220
* Use {@link JsonNull} for JSON null values.
221221
*
222222
* @return mutable {@code Map} view
223+
* @since $next-version$
223224
*/
224225
public Map<String, JsonElement> asMap() {
225226
// It is safe to expose the underlying map because it disallows null keys and values

‎pom.xml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,80 @@
136136
<!-- Disable Maven Super POM release profile and instead use own one -->
137137
<useReleaseProfile>false</useReleaseProfile>
138138
<releaseProfiles>release</releaseProfiles>
139+
<!-- Run custom goals to replace version references, see plugin configuration below -->
140+
<!-- Also run `package`; otherwise goals fail for modules depending on each; possibly
141+
same issue as https://issues.apache.org/jira/browse/MRELEASE-271 -->
142+
<preparationGoals>
143+
package -DskipTests
144+
antrun:run@replace-version-placeholders
145+
antrun:run@replace-old-version-references
146+
antrun:run@git-add-changed
147+
</preparationGoals>
139148
</configuration>
140149
</plugin>
150+
<plugin>
151+
<artifactId>maven-antrun-plugin</artifactId>
152+
<version>3.1.0</version>
153+
<executions>
154+
<!-- Replaces version placeholders with the current version; this is mainly useful for
155+
Javadoc where this allows writing `@since $next-version$` -->
156+
<execution>
157+
<id>replace-version-placeholders</id>
158+
<goals>
159+
<goal>run</goal>
160+
</goals>
161+
<configuration>
162+
<target>
163+
<replace token="$next-version$" value="${project.version}" encoding="${project.build.sourceEncoding}">
164+
<!-- erroronmissingdir=false for gson-parent which does not have source directory -->
165+
<fileset dir="${project.build.sourceDirectory}" includes="**" erroronmissingdir="false" />
166+
</replace>
167+
</target>
168+
</configuration>
169+
</execution>
170+
<!-- Replaces references to the old version in the documentation -->
171+
<execution>
172+
<id>replace-old-version-references</id>
173+
<goals>
174+
<goal>run</goal>
175+
</goals>
176+
<configuration>
177+
<target>
178+
<!-- Replace Maven and Gradle version references; uses regex lookbehind and lookahead -->
179+
<replaceregexp match="(?&lt;=&lt;version&gt;).*(?=&lt;/version&gt;)|(?&lt;='com\.google\.code\.gson:gson:).*(?=')" flags="g" replace="${project.version}" encoding="${project.build.sourceEncoding}">
180+
<fileset dir="${project.basedir}">
181+
<include name="README.md" />
182+
<include name="UserGuide.md" />
183+
</fileset>
184+
</replaceregexp>
185+
</target>
186+
</configuration>
187+
<!-- Only has to be executed for parent project; don't inherit this to modules -->
188+
<!-- This might be a bit hacky; execution with this ID seems to be missing for modules and Maven just executes default
189+
configuration which does not have any targets configured. (not sure if this behavior is guaranteed) -->
190+
<inherited>false</inherited>
191+
</execution>
192+
<!-- Adds changed files to the Git index; workaround because Maven Release Plugin does not support committing
193+
additional files yet (https://issues.apache.org/jira/browse/MRELEASE-798), and for workarounds with
194+
Maven SCM Plugin it is apparently necessary to know modified files in advance -->
195+
<!-- Maven Release Plugin then just happens to include these changed files in its Git commit;
196+
not sure if this behavior is guaranteed or if this relies on implementation details -->
197+
<execution>
198+
<id>git-add-changed</id>
199+
<goals>
200+
<goal>run</goal>
201+
</goals>
202+
<configuration>
203+
<target>
204+
<exec executable="git" dir="${project.basedir}" failonerror="true">
205+
<arg value="add" />
206+
<arg value="." />
207+
</exec>
208+
</target>
209+
</configuration>
210+
</execution>
211+
</executions>
212+
</plugin>
141213
<!-- Plugin for checking source and binary compatibility; used by GitHub workflow -->
142214
<plugin>
143215
<groupId>com.github.siom79.japicmp</groupId>

0 commit comments

Comments
 (0)