README-typetools.md

This is a version of Commons CSV that is annotated with type annotations for the Checker Framework.

To build this project

mvn -B -Dmaven.test.skip=true package

This creates file target/commons-csv-VERSION.jar.

To update to a newer version of the upstream library

Use the latest Checker Framework version by changing pom.xml. Commit and push changes, wait for CI jobs to pass.

At https://github.com/apache/commons-csv/releases , find the commit corresponding to a public release.

Commons CSV version 1.9.0 is commit 8e25a2b30cae841101540c26ff21b79c51ad3eff

Update the PACKAGE environment variable below and file cfMavenCentral.xml .

Pull in the commit:

git pull https://github.com/apache/commons-csv <commitid>

Ensure that the package builds (including type-checking).

To upload to Maven Central

This must be done on a CSE machine, which has access to the necessary passwords.

Set the version number:

* in file cfMavenCentral.xml

* in file pom.xml (if different from upstream; regardless, remove "-SNAPSHOT")

* environment variable PACKAGE below

Ensure you are using JDK 8.

PACKAGE=commons-csv-1.9.0 &&
mvn -B -Dmaven.test.skip=true package &&
mvn source:jar &&
mvn javadoc:javadoc && (cd target/site/apidocs && jar -cf ${PACKAGE}-javadoc.jar org)

This does not seem to work for me:

-Dhomedir=/projects/swlab1/checker-framework/hosting-info

[ ! -z "$PACKAGE" ] &&
mvn gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ -DrepositoryId=sonatype-nexus-staging -DpomFile=cfMavenCentral.xml -Dgpg.publicKeyring=/projects/swlab1/checker-framework/hosting-info/pubring.gpg -Dgpg.secretKeyring=/projects/swlab1/checker-framework/hosting-info/secring.gpg -Dgpg.keyname=ADF4D638 -Dgpg.passphrase="cat /projects/swlab1/checker-framework/hosting-info/release-private.password" -Dfile=target/${PACKAGE}.jar
&&
mvn gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ -DrepositoryId=sonatype-nexus-staging -DpomFile=cfMavenCentral.xml -Dgpg.publicKeyring=/projects/swlab1/checker-framework/hosting-info/pubring.gpg -Dgpg.secretKeyring=/projects/swlab1/checker-framework/hosting-info/secring.gpg -Dgpg.keyname=ADF4D638 -Dgpg.passphrase="cat /projects/swlab1/checker-framework/hosting-info/release-private.password" -Dfile=target/${PACKAGE}-sources.jar -Dclassifier=sources
&&
mvn gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ -DrepositoryId=sonatype-nexus-staging -DpomFile=cfMavenCentral.xml -Dgpg.publicKeyring=/projects/swlab1/checker-framework/hosting-info/pubring.gpg -Dgpg.secretKeyring=/projects/swlab1/checker-framework/hosting-info/secring.gpg -Dgpg.keyname=ADF4D638 -Dgpg.passphrase="cat /projects/swlab1/checker-framework/hosting-info/release-private.password" -Dfile=target/site/apidocs/${PACKAGE}-javadoc.jar -Dclassifier=javadoc

Complete the release at https://oss.sonatype.org/#stagingRepositories