From 50459d048aa469064c507179bb112f992a28d628 Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Sun, 1 Mar 2026 21:32:15 -0800 Subject: [PATCH 1/8] Point at the newer version of the plugin --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index b928a41..1e0c97a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ +> [!CAUTION] +> This repository is obsolete. The source code for the [https://github.com/typetools/checker-framework-gradle-plugin](Gradle Checker Framework Plugin) has moved. +> +> You still use the plugin in the same way; for example, in a `build.gradle` file, write: +> +> ```gradle +> plugins { +> id("org.checkerframework").version("1.0.2") +> } +> ``` +> +> However, there are a few changes. +> See the [https://github.com/typetools/checker-framework-gradle-plugin#migrating-from-0x-to-1x](documentation about migrating] from version 0.x (in this repository) to version 1.x. + # Gradle Checker Framework Plugin [![License](https://img.shields.io/badge/license-apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) From c229054af41dd5516fb3bcb3511f7349bef547b3 Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Sun, 1 Mar 2026 21:34:20 -0800 Subject: [PATCH 2/8] Fix link syntax --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1e0c97a..8969553 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ > [!CAUTION] -> This repository is obsolete. The source code for the [https://github.com/typetools/checker-framework-gradle-plugin](Gradle Checker Framework Plugin) has moved. +> This repository is obsolete. The source code for the [Gradle Checker Framework Plugin](https://github.com/typetools/checker-framework-gradle-plugin) has moved. > > You still use the plugin in the same way; for example, in a `build.gradle` file, write: > @@ -9,8 +9,9 @@ > } > ``` > -> However, there are a few changes. -> See the [https://github.com/typetools/checker-framework-gradle-plugin#migrating-from-0x-to-1x](documentation about migrating] from version 0.x (in this repository) to version 1.x. +> However, there are a few changes. See the [documentation about +> migrating](https://github.com/typetools/checker-framework-gradle-plugin#migrating-from-0x-to-1x) +> from version 0.x to version 1.x. # Gradle Checker Framework Plugin From 43cb4e4081ef4fcedddee3549ce39f4e7302940b Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Sun, 1 Mar 2026 21:43:08 -0800 Subject: [PATCH 3/8] Add more links --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8969553..b7fa568 100644 --- a/README.md +++ b/README.md @@ -25,14 +25,15 @@ Framework](https://checkerframework.org) for pluggable type-checking. Add the following to your `build.gradle` file: -```groovy +
 plugins {
     // Checker Framework pluggable type-checking
+    // NOTE: version 1.x is available
     id("org.checkerframework").version("0.6.61")
 }
 
 apply plugin: "org.checkerframework"
-```
+
The `org.checkerframework` plugin modifies existing Java compilation tasks. You should apply it *after* @@ -115,6 +116,9 @@ definitions of the custom qualifiers. Version 0.6.61 of this plugin uses Checker Framework version 3.52.0 by default. Anytime you upgrade to a newer version of this plugin, it might use a different version of the Checker Framework. +[Version 1.0.0 and later](https://github.com/typetools/checker-framework-gradle-plugin) +of this plugin has no default Checker Framework version; +you *must* specify a version number. You can use a Checker Framework [version](https://github.com/typetools/checker-framework/releases) that is @@ -140,7 +144,8 @@ repositories { } ``` -You can also use a locally-built version of the Checker Framework: +You can also use a locally-built version of the Checker Framework +(this is easier to do in [version 1.x](https://github.com/typetools/checker-framework-gradle-plugin)): ```groovy // To use a locally-built Checker Framework, run gradle with "-PcfLocal". From a664210db94da9dafdf96d308d4a3f114be529f3 Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Sun, 1 Mar 2026 21:45:59 -0800 Subject: [PATCH 4/8] Undo a change --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b7fa568..3a4a066 100644 --- a/README.md +++ b/README.md @@ -23,17 +23,17 @@ Framework](https://checkerframework.org) for pluggable type-checking. ## Download -Add the following to your `build.gradle` file: +Add the following to your `build.gradle` file +(but note that [version 1.x is available](https://github.com/typetools/checker-framework-gradle-plugin): -
+```groovy
 plugins {
     // Checker Framework pluggable type-checking
-    // NOTE: version 1.x is available
     id("org.checkerframework").version("0.6.61")
 }
 
 apply plugin: "org.checkerframework"
-
+``` The `org.checkerframework` plugin modifies existing Java compilation tasks. You should apply it *after* From dfd795dd0405cbd3925d21dce9156033ce595211 Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Sun, 1 Mar 2026 21:47:54 -0800 Subject: [PATCH 5/8] Tweaks --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3a4a066..8a6b24c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ > [!CAUTION] > This repository is obsolete. The source code for the [Gradle Checker Framework Plugin](https://github.com/typetools/checker-framework-gradle-plugin) has moved. > -> You still use the plugin in the same way; for example, in a `build.gradle` file, write: +> You still use the plugin in the same way. For example, in a `build.gradle` file, write: > > ```gradle > plugins { @@ -11,7 +11,7 @@ > > However, there are a few changes. See the [documentation about > migrating](https://github.com/typetools/checker-framework-gradle-plugin#migrating-from-0x-to-1x) -> from version 0.x to version 1.x. +> from version 0.x to version 1.x of the plugin. # Gradle Checker Framework Plugin @@ -24,7 +24,7 @@ Framework](https://checkerframework.org) for pluggable type-checking. ## Download Add the following to your `build.gradle` file -(but note that [version 1.x is available](https://github.com/typetools/checker-framework-gradle-plugin): +(but note that [version 1.x is available](https://github.com/typetools/checker-framework-gradle-plugin#apply-the-plugin)): ```groovy plugins { From 1ace758b8a8586e8598770c5570e36c68ccd29df Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Sun, 1 Mar 2026 21:49:28 -0800 Subject: [PATCH 6/8] More specific link --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8a6b24c..2bc88f4 100644 --- a/README.md +++ b/README.md @@ -144,8 +144,9 @@ repositories { } ``` -You can also use a locally-built version of the Checker Framework -(this is easier to do in [version 1.x](https://github.com/typetools/checker-framework-gradle-plugin)): +You can also use a locally-built version of the Checker Framework (this is +easier to do in [version +1.x](https://github.com/typetools/checker-framework-gradle-plugin#apply-the-plugin)): ```groovy // To use a locally-built Checker Framework, run gradle with "-PcfLocal". From 4bc17fd0b50fe69723d299f8d4acecab4993c45a Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Sun, 1 Mar 2026 21:50:34 -0800 Subject: [PATCH 7/8] Fix link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2bc88f4..ef4fe40 100644 --- a/README.md +++ b/README.md @@ -146,7 +146,7 @@ repositories { You can also use a locally-built version of the Checker Framework (this is easier to do in [version -1.x](https://github.com/typetools/checker-framework-gradle-plugin#apply-the-plugin)): +1.x](https://github.com/typetools/checker-framework-gradle-plugin#the-checker-framework-version)): ```groovy // To use a locally-built Checker Framework, run gradle with "-PcfLocal". From 64562103fd5762a6760f96d38ee93bcfafa7c696 Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Sun, 1 Mar 2026 21:51:45 -0800 Subject: [PATCH 8/8] Link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ef4fe40..893d2a2 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ definitions of the custom qualifiers. Version 0.6.61 of this plugin uses Checker Framework version 3.52.0 by default. Anytime you upgrade to a newer version of this plugin, it might use a different version of the Checker Framework. -[Version 1.0.0 and later](https://github.com/typetools/checker-framework-gradle-plugin) +[Version 1.0.0 and later](https://github.com/typetools/checker-framework-gradle-plugin#the-checker-framework-version) of this plugin has no default Checker Framework version; you *must* specify a version number.