Add CI, use Gradle 8.7 (#99)

.github/dependabot.yml

@@ -5,13 +5,3 @@ updates:
   schedule:
     interval: daily
   open-pull-requests-limit: 10
-  ignore:
-  - dependency-name: com.google.errorprone:javac
-    versions:
-    - 1.8.0-u20
-  - dependency-name: org.checkerframework:framework-test
-    versions:
-    - 3.10.0
-  - dependency-name: org.checkerframework:checker
-    versions:
-    - 3.10.0

.github/workflows/gradle-build.yml

@@ -0,0 +1,25 @@
+name: Java CI with Gradle
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        java: [ '11', '17', '21' ]
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 1
+        show-progress: false
+    - name: Set up JDK
+      uses: actions/setup-java@v4
+      with:
+        distribution: 'temurin'
+        java-version: ${{ matrix.java }}
+    - name: ./gradlew build javadoc
+      run: ./gradlew build

README.md

@@ -1,6 +1,6 @@
 # Template for a checker built on the Checker Framework
 
-This is a template for a pluggable type-checker built on the Checker Framework.
+This repository contains a template for a pluggable type-checker built on the Checker Framework.
 
 ### How to use this template to build your own typechecker
 
@@ -71,6 +71,14 @@ LC_ALL=C find . -type f -exec sed -i -e 's:org/checkerframework/checker/template
 7. Remove all text from the top of this `README.md` file, through this line.
 
 
+# The remainder of this README
+
+The remainder of this README is the user-facing documentation for the analysis
+you will build.
+
+You should remove, from your version, everything above and including this line.
+
+
 # TemplateForA Checker
 
 A common problem when programming is TODO.
@@ -105,7 +113,8 @@ informing you of any potential errors related to TODO.
 ## How to specify your code
 
 At compile time, the TemplateForAChecker estimates what values the program
-may compute at run time.  It issues a warning if the program may TODO.
+may compute at run time.  It issues a warning if the program may
+TODO.
 It works via a technique called pluggable typechecking.
 
 You need to specify the contracts of methods and fields in your code --
@@ -115,7 +124,8 @@ contracts guarantee that TODO.
 
 You specify your code by writing *qualifiers* such as `@TemplateforaBottom`
 on types, to indicate more precisely what values the type represents.
-Here are the type qualifiers that are supported by the TemplateForAChecker:
+Here is a list of the type qualifiers that are supported by
+the TemplateForAChecker, with an explanation of each one:
 
 `@TemplateforaUnknown`:
 The value might or might not be TODO. It is not safe to use for TODO.

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/java/org/checkerframework/checker/templatefora/qual/README

@@ -1,2 +1,2 @@
-The "qual" directory contains a typechecker's type qualifiers, which are
+The `qual/` directory contains a typechecker's type qualifiers, which are
 represented by Java annotations.

tests/templatefora/SubtypingTest.java

@@ -1,12 +1,12 @@
 import org.checkerframework.checker.templatefora.qual.*;
 
-// Test basic subtyping relationships for the TemplateForA Checker.
+// Test subtyping relationships for the TemplateForA Checker.
 class SubtypeTest {
-    void allSubtypingRelationships(@TemplateforaUnknown int x, @TemplateforaBottom int y) {
-        @TemplateforaUnknown int a = x;
-        @TemplateforaUnknown int b = y;
-        // :: error: assignment
-        @TemplateforaBottom int c = x; // expected error on this line
-        @TemplateforaBottom int d = y;
-    }
+  void allSubtypingRelationships(@TemplateforaUnknown int x, @TemplateforaBottom int y) {
+    @TemplateforaUnknown int a = x;
+    @TemplateforaUnknown int b = y;
+    // :: error: assignment
+    @TemplateforaBottom int c = x; // expected error on this line
+    @TemplateforaBottom int d = y;
+  }
 }