-
Notifications
You must be signed in to change notification settings - Fork 4.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make Maven build reproducible #2543
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,6 +37,72 @@ This section was borrowed heavily from [Doclava release process](https://code.go | |
|
||
See [OSSRH Publish Guide](https://central.sonatype.org/publish/publish-guide/). | ||
|
||
## Testing Maven release workflow locally | ||
|
||
The following describes how to perform the steps of the release locally to verify that they work as desired. | ||
|
||
**Warning:** Be careful with this, these steps might be outdated or incomplete. Doublecheck that you are working on a copy of your local Gson Git repository and make sure you have followed all steps. To be safe you can also temporarily turn off your internet connection to avoid accidentally pushing changes to the real remote Git or Maven repository.\ | ||
Comment on lines
+40
to
+44
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This setup is a bit hacky and I am not sure if there is a proper better alternative to this, therefore I added this "Warning". But it does allow you to test the behavior of the release workflow quite accurately, which is why I added it. |
||
As an alternative to the steps described below you can instead [perform a dry run](https://maven.apache.org/maven-release/maven-release-plugin/usage.html#do-a-dry-run), though this might not behave identical to a real release. | ||
|
||
1. Make a copy of your local Gson Git repository and only work with that copy | ||
2. Make sure you are on the `main` branch | ||
3. Create a temp directory outside the Gson directory\ | ||
In the following steps this will be called `#gson-remote-temp#`; replace this with the actual absolute file path of the directory, using only forward slashes. For example under Windows `C:\my-dir` becomes `C:/my-dir`. | ||
4. Create the directory `#gson-remote-temp#/git-repo` | ||
5. In that directory run | ||
|
||
```sh | ||
git init --bare --initial-branch=main . | ||
``` | ||
|
||
6. Create the directory `#gson-remote-temp#/maven-repo` | ||
7. Edit the root `pom.xml` of Gson | ||
1. Change the `<developerConnection>` to | ||
|
||
```txt | ||
scm:git:file:///#gson-remote-temp#/git-repo | ||
``` | ||
|
||
2. Change the `<url>` of the `<distributionManagement>` to | ||
|
||
```txt | ||
file:///#gson-remote-temp#/maven-repo | ||
``` | ||
|
||
3. If you don't want to use GPG, remove the `maven-gpg-plugin` entry from the 'release' profile.\ | ||
There is also an entry under `<pluginManagement>`; you can remove that as well. | ||
8. Commit the changes using Git | ||
9. Change the remote repository of the Git project | ||
<!-- Uses `txt` instead of `sh` to avoid the `#` being highlighted in some way --> | ||
```txt | ||
git remote set-url origin file:///#gson-remote-temp#/git-repo | ||
``` | ||
10. Push the changes | ||
```sh | ||
git push origin main | ||
``` | ||
Now you can perform the steps of the release: | ||
1. ```sh | ||
mvn release:clean | ||
``` | ||
2. ```sh | ||
mvn release:prepare | ||
``` | ||
3. ```sh | ||
mvn release:perform | ||
``` | ||
4. Verify that `#gson-remote-temp#/git-repo` and `#gson-remote-temp#/maven-repo` contain all the desired changes | ||
5. Afterwards delete all Gson files under `${user.home}/.m2/repository/com/google/code/gson` which have been installed in your local Maven repository during the release.\ | ||
Otherwise Maven might not download the real Gson artifacts with these version numbers, once they are released. | ||
## Running Benchmarks or Tests on Android | ||
* Download vogar | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,8 +14,7 @@ | |
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd" | ||
child.project.url.inherit.append.path="false"> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd" child.project.url.inherit.append.path="false"> | ||
<modelVersion>4.0.0</modelVersion> | ||
|
||
<groupId>com.google.code.gson</groupId> | ||
|
@@ -40,6 +39,10 @@ | |
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
<maven.compiler.release>7</maven.compiler.release> | ||
<maven.compiler.testRelease>11</maven.compiler.testRelease> | ||
|
||
<!-- Make the build reproducible, see https://maven.apache.org/guides/mini/guide-reproducible-builds.html --> | ||
<!-- Automatically updated by Maven Release Plugin --> | ||
<project.build.outputTimestamp>2023-01-01T00:00:00Z</project.build.outputTimestamp> | ||
</properties> | ||
|
||
<!-- These attributes specify that the URLs should be inherited by the modules as is, to avoid constructing | ||
|
@@ -152,8 +155,8 @@ | |
<!-- For Markdown files removing trailing whitespace causes issues for hard line breaks, | ||
which use two trailing spaces. However, the trailing spaces are difficult to notice anyway; | ||
prefer a trailing `\` instead of two spaces. --> | ||
<trimTrailingWhitespace/> | ||
<endWithNewline/> | ||
<trimTrailingWhitespace /> | ||
<endWithNewline /> | ||
<indent> | ||
<spaces>true</spaces> | ||
<!-- This seems to mostly (or only?) affect the suggested fix in case code contains tabs --> | ||
|
@@ -175,10 +178,29 @@ | |
<reorderImports>true</reorderImports> | ||
<formatJavadoc>true</formatJavadoc> | ||
</googleJavaFormat> | ||
<formatAnnotations/> <!-- Puts type annotations immediately before types. --> | ||
<formatAnnotations /> <!-- Puts type annotations immediately before types. --> | ||
</java> | ||
</configuration> | ||
</plugin> | ||
|
||
<!-- Attaches a `.buildinfo` file which contains information for reproducing the build, | ||
such as OS, JDK version, ... | ||
Since this is a multi-module Maven project, only one aggregated file will be created for | ||
the last module, see the note on https://maven.apache.org/plugins/maven-artifact-plugin/usage.html#recording-buildinfo-file --> | ||
<!-- The other goals of this plugin are run by the GitHub workflow to verify that | ||
the build is reproducible (see `artifact:...` usage in the workflow) --> | ||
<plugin> | ||
<groupId>org.apache.maven.plugins</groupId> | ||
<artifactId>maven-artifact-plugin</artifactId> | ||
Comment on lines
+186
to
+194
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This includes information about the build environment to make it easier to reproduce the build. I am not sure if you would consider some of this information sensitive (e.g. OS name and version or Java vendor and version). For example for me the generated file looks like this:
|
||
<version>3.5.0</version> | ||
<executions> | ||
<execution> | ||
<goals> | ||
<goal>buildinfo</goal> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This causes a warning during the build:
But I guess that can be safely ignored because during release |
||
</goals> | ||
</execution> | ||
</executions> | ||
</plugin> | ||
</plugins> | ||
|
||
<pluginManagement> | ||
|
@@ -350,6 +372,7 @@ | |
</execution> | ||
</executions> | ||
</plugin> | ||
|
||
<!-- Plugin for checking source and binary compatibility; used by GitHub workflow --> | ||
<plugin> | ||
<groupId>com.github.siom79.japicmp</groupId> | ||
|
@@ -381,6 +404,7 @@ | |
</parameter> | ||
</configuration> | ||
</plugin> | ||
|
||
<!-- Plugin for checking compatibility with Android API --> | ||
<!-- Note: For now this is not part of a normal Maven build but instead executed only by a | ||
GitHub workflow because the Animal Sniffer signature files use Java Serialization, so they | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have included this as separate job (instead of including it in the steps of the build above) because it requires running
mvn ... install
which is normally not needed for a regular build, and also to keep it independent from the 'real' build setup above.However, this makes the GitHub workflow slightly slower though.