From da209b26b213e3930c5f7ca710de9f1a17ad57d0 Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Thu, 2 Dec 2021 08:29:00 -0800 Subject: [PATCH 1/2] Use Checker Framework version 3.19.0 --- README-typetools.md | 17 +++++++++++++---- pom.xml | 6 +++--- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/README-typetools.md b/README-typetools.md index e9f222af225..4f502fff231 100644 --- a/README-typetools.md +++ b/README-typetools.md @@ -15,12 +15,23 @@ This creates file To update to a newer version of the upstream library ---------------------------------------------------- -Create a branch and do work thre. +First, update to use the latest Checker Framework by editing file +`pom.xml` (3 places, for `checker-qual` and `checker`). +Make a pull request to ensure that type-checking succeeds. + +Create a branch and do work there. + +Use the latest Checker Framework version by changing `pom.xml`. + +Ensure that it builds: +``` +mvn -B -Dmaven.test.skip=true package +``` At https://github.com/apache/commons-io/releases , find the commit corresponding to a public release. -Commons IO version 2.8.0 is commit fa59009aaabcf8671a8d741993ef355f42b95ccd +Commons IO version 2.11.0 is commit 8985de8fe74f6622a419b37a6eed0dbc484dc128 Pull in that commit: ``` @@ -29,8 +40,6 @@ git pull https://github.com/apache/commons-io Update the version number throughout this file. -Use the latest Checker Framework version by changing `pom.xml`. - Search the codebase for all uses of "@since 2.8.0" and annotate those methods/classes. Ensure that it builds: diff --git a/pom.xml b/pom.xml index 03a22c22cd5..28222b28a67 100644 --- a/pom.xml +++ b/pom.xml @@ -264,7 +264,7 @@ file comparators, endian transformation classes, and much more. org.checkerframework checker-qual - 3.17.0 + 3.19.0 com.google.errorprone @@ -537,7 +537,7 @@ file comparators, endian transformation classes, and much more. org.checkerframework checker - 3.17.0 + 3.19.0 @@ -558,7 +558,7 @@ file comparators, endian transformation classes, and much more. org.checkerframework checker - 3.17.0 + 3.19.0 From 267280fc78f24a1922cb6f7b2d5ed36091a98ce7 Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Thu, 2 Dec 2021 08:32:00 -0800 Subject: [PATCH 2/2] Adjust README --- README-typetools.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README-typetools.md b/README-typetools.md index 4f502fff231..69d5ae83281 100644 --- a/README-typetools.md +++ b/README-typetools.md @@ -17,16 +17,14 @@ To update to a newer version of the upstream library First, update to use the latest Checker Framework by editing file `pom.xml` (3 places, for `checker-qual` and `checker`). -Make a pull request to ensure that type-checking succeeds. - -Create a branch and do work there. - -Use the latest Checker Framework version by changing `pom.xml`. - Ensure that it builds: ``` mvn -B -Dmaven.test.skip=true package ``` +Make a pull request to ensure that type-checking succeeds. + +Now, do the upstream library update. +Create a branch and do work there. At https://github.com/apache/commons-io/releases , find the commit corresponding to a public release.