From 7b81dc44e55e1e9f9de11f94a1d078a57328a714 Mon Sep 17 00:00:00 2001 From: Stephan Schroevers Date: Fri, 10 Jan 2025 16:40:59 +0100 Subject: [PATCH] Upgrade Error Prone fork 2.36.0-picnic-1 -> 2.36.0-picnic-2 (#1499) This new release is published using GitHub Packages rather than JitPack. This comes with a simpler release setup and a (hopefully) more stable package repository. A minor downside is that GitHub Packages require authenticated access, even for read access. The documentation has been updated accordingly. The new release is no longer published using a custom groupId, enabling some build simplifications. While there, some obsolete fork-related documentation and configuration is dropped. See: - https://github.com/PicnicSupermarket/error-prone/releases/tag/v2.36.0-picnic-2 - https://github.com/PicnicSupermarket/error-prone/compare/v2.36.0-picnic-1...v2.36.0-picnic-2 --- .github/workflows/build.yml | 4 + .github/workflows/deploy-website.yml | 1 + README.md | 15 +-- documentation-support/pom.xml | 36 +++--- error-prone-contrib/pom.xml | 50 ++++---- error-prone-experimental/pom.xml | 40 +++--- error-prone-guidelines/pom.xml | 50 ++++---- error-prone-utils/pom.xml | 8 +- pom.xml | 114 +++++------------- refaster-compiler/pom.xml | 26 ++-- refaster-runner/pom.xml | 40 +++--- refaster-support/pom.xml | 57 ++++----- refaster-test-support/pom.xml | 44 +++---- settings.xml | 15 ++- ...generate-version-compatibility-overview.sh | 2 +- 15 files changed, 224 insertions(+), 278 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8c3283b3..cb65a408 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -33,7 +33,9 @@ jobs: allowed-endpoints: > api.adoptium.net:443 github.com:443 + github-registry-files.githubusercontent.com:443 jitpack.io:443 + maven.pkg.github.com:443 objects.githubusercontent.com:443 repo.maven.apache.org:443 # We run the build twice for each supported JDK: once against the @@ -53,6 +55,8 @@ jobs: run: mvn -T1C install javadoc:jar - name: Build project with self-check against Error Prone fork run: mvn -T1C clean verify -Perror-prone-fork -Pnon-maven-central -Pself-check -s settings.xml + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Remove installed project artifacts run: mvn dependency:purge-local-repository -DmanualInclude='${project.groupId}' -DresolutionFuzziness=groupId diff --git a/.github/workflows/deploy-website.yml b/.github/workflows/deploy-website.yml index 0780d9fe..ccc1fc5e 100644 --- a/.github/workflows/deploy-website.yml +++ b/.github/workflows/deploy-website.yml @@ -21,6 +21,7 @@ jobs: api.github.com:443 bestpractices.coreinfrastructure.org:443 blog.picnic.nl:443 + docs.github.com:443 errorprone.info:443 github.com:443 img.shields.io:443 diff --git a/README.md b/README.md index 76a48614..3038e1c7 100644 --- a/README.md +++ b/README.md @@ -205,12 +205,13 @@ Relevant Maven build parameters: version of Error Prone. This is useful e.g. when testing a locally built Error Prone SNAPSHOT. - `-Perror-prone-fork` runs the build using Picnic's [Error Prone - fork][error-prone-fork-repo], hosted on [Jitpack][error-prone-fork-jitpack]. - This fork generally contains a few changes on top of the latest Error Prone - release. + fork][error-prone-fork-repo], hosted using [GitHub + Packages][error-prone-fork-packages]. This fork generally contains a few + changes on top of the latest Error Prone release. Using this profile + generally requires passing `-s settings.xml`, with [suitably + configured][github-packages-auth] `GITHUB_ACTOR` and `GITHUB_TOKEN` + environment variables. - `-Pself-check` runs the checks defined by this project against itself. - Pending a release of [google/error-prone#3301][error-prone-pull-3301], this - flag must currently be used in combination with `-Perror-prone-fork`. Other highly relevant commands: @@ -275,14 +276,14 @@ channel; please see our [security policy][security] for details. [contributing]: https://github.com/PicnicSupermarket/error-prone-support/blob/master/CONTRIBUTING.md [contributing-pull-request]: https://github.com/PicnicSupermarket/error-prone-support/blob/master/CONTRIBUTING.md#-opening-a-pull-request [error-prone-bugchecker]: https://github.com/google/error-prone/blob/master/check_api/src/main/java/com/google/errorprone/bugpatterns/BugChecker.java -[error-prone-fork-jitpack]: https://jitpack.io/#PicnicSupermarket/error-prone +[error-prone-fork-packages]: https://github.com/PicnicSupermarket/error-prone/packages [error-prone-fork-repo]: https://github.com/PicnicSupermarket/error-prone [error-prone-gradle-installation-guide]: https://github.com/tbroyer/gradle-errorprone-plugin [error-prone-installation-guide]: https://errorprone.info/docs/installation#maven [error-prone-orig-repo]: https://github.com/google/error-prone -[error-prone-pull-3301]: https://github.com/google/error-prone/pull/3301 [github-actions-build-badge]: https://github.com/PicnicSupermarket/error-prone-support/actions/workflows/build.yml/badge.svg [github-actions-build-master]: https://github.com/PicnicSupermarket/error-prone-support/actions/workflows/build.yml?query=branch:master&event=push +[github-packages-auth]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages [google-java-format]: https://github.com/google/google-java-format [idea-288052]: https://youtrack.jetbrains.com/issue/IDEA-288052 [license-badge]: https://img.shields.io/github/license/PicnicSupermarket/error-prone-support diff --git a/documentation-support/pom.xml b/documentation-support/pom.xml index 4b1aa06f..b9ca3c12 100644 --- a/documentation-support/pom.xml +++ b/documentation-support/pom.xml @@ -15,24 +15,6 @@ https://error-prone.picnic.tech - - ${groupId.error-prone} - error_prone_annotation - - - ${groupId.error-prone} - error_prone_annotations - provided - - - ${groupId.error-prone} - error_prone_check_api - - - ${groupId.error-prone} - error_prone_test_helpers - test - ${project.groupId} error-prone-utils @@ -72,6 +54,24 @@ auto-value-annotations provided + + com.google.errorprone + error_prone_annotation + + + com.google.errorprone + error_prone_annotations + provided + + + com.google.errorprone + error_prone_check_api + + + com.google.errorprone + error_prone_test_helpers + test + com.google.guava guava diff --git a/error-prone-contrib/pom.xml b/error-prone-contrib/pom.xml index 9912be1a..896e2c39 100644 --- a/error-prone-contrib/pom.xml +++ b/error-prone-contrib/pom.xml @@ -15,31 +15,6 @@ https://error-prone.picnic.tech - - ${groupId.error-prone} - error_prone_annotation - provided - - - ${groupId.error-prone} - error_prone_annotations - provided - - - ${groupId.error-prone} - error_prone_check_api - provided - - - ${groupId.error-prone} - error_prone_core - provided - - - ${groupId.error-prone} - error_prone_test_helpers - provided - ${project.groupId} documentation-support @@ -87,6 +62,31 @@ auto-value-annotations provided + + com.google.errorprone + error_prone_annotation + provided + + + com.google.errorprone + error_prone_annotations + provided + + + com.google.errorprone + error_prone_check_api + provided + + + com.google.errorprone + error_prone_core + provided + + + com.google.errorprone + error_prone_test_helpers + provided + com.google.guava guava diff --git a/error-prone-experimental/pom.xml b/error-prone-experimental/pom.xml index cfcfb622..1cbfc4d6 100644 --- a/error-prone-experimental/pom.xml +++ b/error-prone-experimental/pom.xml @@ -15,26 +15,6 @@ https://error-prone.picnic.tech - - ${groupId.error-prone} - error_prone_annotation - provided - - - ${groupId.error-prone} - error_prone_annotations - provided - - - ${groupId.error-prone} - error_prone_check_api - provided - - - ${groupId.error-prone} - error_prone_test_helpers - provided - ${project.groupId} error-prone-utils @@ -45,6 +25,26 @@ auto-service-annotations provided + + com.google.errorprone + error_prone_annotation + provided + + + com.google.errorprone + error_prone_annotations + provided + + + com.google.errorprone + error_prone_check_api + provided + + + com.google.errorprone + error_prone_test_helpers + provided + com.google.guava guava diff --git a/error-prone-guidelines/pom.xml b/error-prone-guidelines/pom.xml index d6299bf1..745fbf13 100644 --- a/error-prone-guidelines/pom.xml +++ b/error-prone-guidelines/pom.xml @@ -15,31 +15,6 @@ https://error-prone.picnic.tech - - ${groupId.error-prone} - error_prone_annotation - provided - - - ${groupId.error-prone} - error_prone_annotations - provided - - - ${groupId.error-prone} - error_prone_check_api - provided - - - ${groupId.error-prone} - error_prone_core - provided - - - ${groupId.error-prone} - error_prone_test_helpers - provided - ${project.groupId} documentation-support @@ -68,6 +43,31 @@ auto-service-annotations provided + + com.google.errorprone + error_prone_annotation + provided + + + com.google.errorprone + error_prone_annotations + provided + + + com.google.errorprone + error_prone_check_api + provided + + + com.google.errorprone + error_prone_core + provided + + + com.google.errorprone + error_prone_test_helpers + provided + com.google.googlejavaformat google-java-format diff --git a/error-prone-utils/pom.xml b/error-prone-utils/pom.xml index e3fd511d..9f0e9f1f 100644 --- a/error-prone-utils/pom.xml +++ b/error-prone-utils/pom.xml @@ -16,22 +16,22 @@ - ${groupId.error-prone} + com.google.errorprone error_prone_annotation provided - ${groupId.error-prone} + com.google.errorprone error_prone_annotations provided - ${groupId.error-prone} + com.google.errorprone error_prone_check_api provided - ${groupId.error-prone} + com.google.errorprone error_prone_test_helpers provided diff --git a/pom.xml b/pom.xml index 32d525f9..1e217db8 100644 --- a/pom.xml +++ b/pom.xml @@ -144,11 +144,6 @@ specified. Used by the `patch` and `self-check` profiles. --> - - com.google.errorprone 2024-11-03T15:58:19Z @@ -210,7 +205,7 @@ 1.1.1 1.11.0 ${version.error-prone-orig} - v${version.error-prone-orig}-picnic-1 + ${version.error-prone-orig}-picnic-2 2.36.0 0.1.28 1.0 @@ -226,31 +221,6 @@ - - ${groupId.error-prone} - error_prone_annotation - ${version.error-prone} - - - ${groupId.error-prone} - error_prone_annotations - ${version.error-prone} - - - ${groupId.error-prone} - error_prone_check_api - ${version.error-prone} - - - ${groupId.error-prone} - error_prone_core - ${version.error-prone} - - - ${groupId.error-prone} - error_prone_test_helpers - ${version.error-prone} - ${project.groupId} documentation-support @@ -333,6 +303,31 @@ auto-value-annotations ${version.auto-value} + + com.google.errorprone + error_prone_annotation + ${version.error-prone} + + + com.google.errorprone + error_prone_annotations + ${version.error-prone} + + + com.google.errorprone + error_prone_check_api + ${version.error-prone} + + + com.google.errorprone + error_prone_core + ${version.error-prone} + + + com.google.errorprone + error_prone_test_helpers + ${version.error-prone} + com.google.googlejavaformat google-java-format @@ -1607,63 +1602,8 @@ error-prone-fork - com.github.PicnicSupermarket.error-prone ${version.error-prone-fork} - - - - - com.google.errorprone - error_prone_annotations - ${version.error-prone-orig} - - - - - - - - org.apache.maven.plugins - maven-enforcer-plugin - - - - - - - com.google.errorprone - error_prone_annotations - - * - - - - - - - - - org.apache.maven.plugins - maven-surefire-plugin - - - - true - - - - - - - ${groupId.error-prone} + com.google.errorprone error_prone_core ${version.error-prone} diff --git a/refaster-compiler/pom.xml b/refaster-compiler/pom.xml index 2946dbb4..fdf4afdb 100644 --- a/refaster-compiler/pom.xml +++ b/refaster-compiler/pom.xml @@ -15,19 +15,6 @@ https://error-prone.picnic.tech - - ${groupId.error-prone} - error_prone_annotations - provided - - - ${groupId.error-prone} - error_prone_check_api - - - ${groupId.error-prone} - error_prone_core - ${project.groupId} refaster-support @@ -37,6 +24,19 @@ auto-service-annotations provided + + com.google.errorprone + error_prone_annotations + provided + + + com.google.errorprone + error_prone_check_api + + + com.google.errorprone + error_prone_core + com.google.guava guava diff --git a/refaster-runner/pom.xml b/refaster-runner/pom.xml index 459a314e..f75ed47b 100644 --- a/refaster-runner/pom.xml +++ b/refaster-runner/pom.xml @@ -15,26 +15,6 @@ https://error-prone.picnic.tech - - ${groupId.error-prone} - error_prone_annotation - provided - - - ${groupId.error-prone} - error_prone_annotations - provided - - - ${groupId.error-prone} - error_prone_check_api - provided - - - ${groupId.error-prone} - error_prone_test_helpers - test - ${project.groupId} refaster-compiler @@ -53,6 +33,26 @@ auto-service-annotations provided + + com.google.errorprone + error_prone_annotation + provided + + + com.google.errorprone + error_prone_annotations + provided + + + com.google.errorprone + error_prone_check_api + provided + + + com.google.errorprone + error_prone_test_helpers + test + com.google.guava guava diff --git a/refaster-support/pom.xml b/refaster-support/pom.xml index 3176949f..6370d8f1 100644 --- a/refaster-support/pom.xml +++ b/refaster-support/pom.xml @@ -15,43 +15,36 @@ https://error-prone.picnic.tech - - - - ${groupId.error-prone} - error_prone_annotations - provided - - - - ${groupId.error-prone} - error_prone_annotation - provided - - - ${groupId.error-prone} - error_prone_check_api - provided - - - ${groupId.error-prone} - error_prone_core - provided - - - ${groupId.error-prone} - error_prone_test_helpers - test - com.google.auto.value auto-value-annotations provided + + com.google.errorprone + error_prone_annotation + provided + + + com.google.errorprone + error_prone_annotations + provided + + + com.google.errorprone + error_prone_check_api + provided + + + com.google.errorprone + error_prone_core + provided + + + com.google.errorprone + error_prone_test_helpers + test + com.google.guava guava diff --git a/refaster-test-support/pom.xml b/refaster-test-support/pom.xml index 89b7795c..46dca581 100644 --- a/refaster-test-support/pom.xml +++ b/refaster-test-support/pom.xml @@ -15,28 +15,6 @@ https://error-prone.picnic.tech - - ${groupId.error-prone} - error_prone_annotation - - - ${groupId.error-prone} - error_prone_annotations - provided - - - ${groupId.error-prone} - error_prone_check_api - - - ${groupId.error-prone} - error_prone_core - test - - - ${groupId.error-prone} - error_prone_test_helpers - ${project.groupId} refaster-runner @@ -46,6 +24,28 @@ auto-service-annotations provided + + com.google.errorprone + error_prone_annotation + + + com.google.errorprone + error_prone_annotations + provided + + + com.google.errorprone + error_prone_check_api + + + com.google.errorprone + error_prone_core + test + + + com.google.errorprone + error_prone_test_helpers + com.google.guava guava diff --git a/settings.xml b/settings.xml index dc0a0822..799f0750 100644 --- a/settings.xml +++ b/settings.xml @@ -5,13 +5,13 @@ + Prone. This fork is hosted using GitHub Packages. See + https://github.com/PicnicSupermarket/error-prone/packages. --> error-prone-fork - jitpack.io - https://jitpack.io + error-prone-fork + https://maven.pkg.github.com/PicnicSupermarket/error-prone @@ -29,4 +29,11 @@ + + + error-prone-fork + ${env.GITHUB_ACTOR} + ${env.GITHUB_TOKEN} + + diff --git a/website/generate-version-compatibility-overview.sh b/website/generate-version-compatibility-overview.sh index c0716db6..19cb110b 100755 --- a/website/generate-version-compatibility-overview.sh +++ b/website/generate-version-compatibility-overview.sh @@ -86,7 +86,7 @@ for eps_version in ${eps_versions}; do -Ppatch \ -Pself-check \ -Dverification.skip \ - -Dversion.error-prone-orig="${ep_version}" \ + -Dversion.error-prone="${ep_version}" \ && echo "SUCCESS: { \"eps_version\": \"${eps_version}\", \"ep_version\": \"${ep_version}\" }" || true # Undo any changes applied by the checks. git checkout -- '*.java'