Add IntelliJ profiler usage guide to developer manual

.gitattributes

@@ -0,0 +1,11 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Denote all files that are truly binary and should not be modified.
+*.jar     binary
+*.class   binary
+*.png     binary
+*.jpg     binary
+*.pdf     binary
+
+*.bat text eol=crlf

.github/renovate.json

@@ -9,6 +9,10 @@
   ],
   "timezone": "America/Los_Angeles",
   "packageRules": [
+    {
+      "matchPackagePatterns": ["^adoptium/temurin\\d+-binaries$"],
+      "ignoreUnstable": false
+    },
     {
       "matchPackageNames": ["com.amazonaws:aws-java-sdk-bom"],
       "schedule": ["before 3am on the first day of the month"]
@@ -18,5 +22,25 @@
       "matchPackageNames": ["org.apache.spark:spark-sql_2.12"],
       "enabled": false
     }
+  ],
+  "regexManagers": [
+    {
+      "description": "Update USE_BAZEL_VERSION in GitHub Actions",
+      "fileMatch": ["^\\.github/workflows/.*\\.yml$"],
+      "matchStrings": ["USE_BAZEL_VERSION: \"(?<currentValue>.*?)\""],
+      "datasourceTemplate": "github-releases",
+      "depNameTemplate": "bazelbuild/bazel"
+    },
+    {
+      "description": "Update JDK_EA_BUILD in GitHub Actions",
+      "fileMatch": ["^\\.github/workflows/ci\\.yml$"],
+      "matchStrings": [
+        "JDK_EA_MAJOR:\\s+\"(?<major>\\d+)\"[\\s\\S]*?JDK_EA_BUILD:\\s+\"(?<currentValue>\\d+)\""
+      ],
+      "datasourceTemplate": "github-releases",
+      "versioningTemplate": "loose",
+      "depNameTemplate": "adoptium/temurin{{{major}}}-binaries",
+      "extractVersionTemplate": "^jdk-\\d+\\+(?<version>\\d+)"
+    }
   ]
 }

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
   # Basic sanity tests on JDK 21.
   sanity:
     name: ${{ matrix.script }} on JDK ${{ matrix.java_version }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     permissions:
       contents: read
     strategy:
@@ -26,8 +26,9 @@ jobs:
         java_version: [21]
     env:
       JAVA_VERSION: ${{ matrix.java_version }}
+      USE_BAZEL_VERSION: "9.0.1"
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
     - name: Set up JDK ${{ matrix.java_version }}
       uses: actions/setup-java@v5
       with:
@@ -37,10 +38,10 @@ jobs:
     # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies.
     # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
     - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@v4.4.3
+      uses: gradle/actions/setup-gradle@v5.0.2
 
     - name: Setup Bazel
-      uses: bazel-contrib/setup-bazel@0.15.0
+      uses: bazel-contrib/setup-bazel@0.18.0
       if: ${{ matrix.script == 'cftests-nonjunit' }}
       with:
         # Avoid downloading Bazel every time.
@@ -56,14 +57,15 @@ jobs:
   # The remaining tests for JDK 21. Separate from `sanity` to allow parallelism with `otheros`.
   remainder:
     name: ${{ matrix.script }} on JDK ${{ matrix.java_version }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     # Don't depend on sanity jobs, to have more parallelism.
     # TODO: cancel these jobs if sanity fails.
     # needs: sanity
     permissions:
       contents: read
     strategy:
-      fail-fast: true
+      # Run all `remainder` tasks, even if one fails.
+      fail-fast: false
       matrix:
         # No need to run 'cftests-junit-jdk21' on JDK 21.
         script: ['typecheck-part1', 'typecheck-part2',
@@ -75,11 +77,11 @@ jobs:
     env:
       JAVA_VERSION: ${{ matrix.java_version }}
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
       if: ${{ matrix.script != 'misc' }}
       with:
         fetch-depth: 1
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
       if: ${{ matrix.script == 'misc' }}
       with:
         # CI diff needs more history - 0 fetches all history.
@@ -93,7 +95,7 @@ jobs:
     # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies.
     # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
     - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@v4.4.3
+      uses: gradle/actions/setup-gradle@v5.0.2
       # Setup for misc tests
     - name: Install misc dependencies
       if: ${{ matrix.script == 'misc' }}
@@ -112,10 +114,15 @@ jobs:
 
   otherjdks:
     name: ${{ matrix.script }} on JDK ${{ matrix.java.version }}
-    runs-on: ubuntu-latest
-    needs: sanity
+    runs-on: ubuntu-24.04
+    needs: [sanity, remainder]
     permissions:
       contents: read
+    env:
+      JAVA_VERSION: ${{ matrix.java.version }}
+      USE_BAZEL_VERSION: "9.0.1"
+      JDK_EA_MAJOR: "26"
+      JDK_EA_BUILD: "35"
     strategy:
       fail-fast: true
       matrix:
@@ -126,12 +133,13 @@ jobs:
           'daikon-part1', 'daikon-part2',
           'misc']
         # JDK 21 used by `sanity` and `remainder` before.
+        # Keep all LTS versions and the newest non-LTS version.
         # `experimental` versions use the $version compiler, but run on JDK 21.
         java: [{version: '8', experimental: false},
           {version: '11', experimental: false},
           {version: '17', experimental: false},
-          {version: '24', experimental: false},
-          {version: '25.0.0-ea.36.0.ea', experimental: true}]
+          {version: '25', experimental: false},
+          {version: 'ea', experimental: true}]
         exclude:
           # JDK 8 does not allow toolchains, so testing 'cftests-junit-jdk21' is unnecessary.
           - script: 'cftests-junit-jdk21'
@@ -173,18 +181,15 @@ jobs:
             java: {version: '17', experimental: false}
           - script: 'daikon-part2'
             java: {version: '17', experimental: false}
-
-    env:
-      JAVA_VERSION: ${{ matrix.java.version }}
     continue-on-error: ${{ matrix.java.experimental }}
     steps:
     - name: Check out sources
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
       if: ${{ matrix.script != 'misc' }}
       with:
         fetch-depth: 1
     - name: Check out sources with all history
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
       if: ${{ matrix.script == 'misc' }}
       with:
         # CI diff needs more history - 0 fetches all history.
@@ -199,15 +204,15 @@ jobs:
       uses: actions/setup-java@v5
       with:
         # Install the requested JDK second, to make it the default on which everything else runs.
-        java-version: ${{ matrix.java.version }}
+        java-version: ${{ matrix.java.version == 'ea' && format('{0}.0.0-ea.{1}.0.ea', env.JDK_EA_MAJOR, env.JDK_EA_BUILD) || matrix.java.version }}
         distribution: 'temurin'
     - name: Inject JAVA_HOME_21_64 into `gradle.properties` to always use JDK 21 for Gradle
       run: mkdir ~/.gradle && echo "org.gradle.java.home=$JAVA_HOME_21_X64" >> ~/.gradle/gradle.properties
 
     # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies.
     # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
     - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@v4.4.3
+      uses: gradle/actions/setup-gradle@v5.0.2
     - name: Install misc dependencies
       if: ${{ matrix.script == 'misc' }}
       run: |
@@ -221,7 +226,7 @@ jobs:
           texlive-font-utils texlive-fonts-recommended texlive-latex-recommended
         pip install black flake8 html5validator
     - name: Setup Bazel
-      uses: bazel-contrib/setup-bazel@0.15.0
+      uses: bazel-contrib/setup-bazel@0.18.0
       if: ${{ matrix.script == 'cftests-nonjunit' }}
       with:
         # Avoid downloading Bazel every time.
@@ -239,7 +244,7 @@ jobs:
       # Set the JDK version to use, allowing us to e.g. run Java 25 while gradle does not work
       # on Java 25 yet.
       env:
-        ORG_GRADLE_PROJECT_useJdkVersion: ${{ matrix.java.version }}
+        ORG_GRADLE_PROJECT_useJdkVersion: ${{ matrix.java.version == 'ea' && env.JDK_EA_MAJOR || matrix.java.version }}
 
   # Sanity tests on Windows and MacOS.
   otheros:
@@ -256,7 +261,7 @@ jobs:
     env:
       JAVA_VERSION: ${{ matrix.java_version }}
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
     - name: Set up JDK ${{ matrix.java_version }}
       uses: actions/setup-java@v5
       with:
@@ -266,7 +271,7 @@ jobs:
     # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies.
     # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
     - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@v4.4.3
+      uses: gradle/actions/setup-gradle@v5.0.2
 
     - name: Install coreutils on MacOS
       if: ${{ matrix.os == 'macos-latest' }}

README.md

@@ -7,5 +7,66 @@ Please see the EISOP Checker Framework manual
 The history of releases and changes is in file
 [docs/CHANGELOG.md](docs/CHANGELOG.md).
 
-Documentation for Checker Framework developers
-is in directory [docs/developer/](docs/developer/).
+See below for EISOP Checker Framework development notes.
+
+## Quick Start Guide
+
+1. Clone this repository in some empty directory:
+   ```
+   git clone git@github.com:eisop/checker-framework.git
+   cd checker-framework
+   ```
+
+2. Build the EISOP Checker Framework (requires JDK 8+):
+   ```
+   ./gradlew assemble
+   ```
+   This will clone the required [eisop/jdk](https://github.com/eisop/jdk) project to a sibling directory called `jdk` and build everything without running the test suite.
+   There will be warnings about missing javadoc, but overall the build should be successful.
+
+3. Run a simple test:
+   ```
+   ./checker/bin/javac -processor nullness docs/examples/NullnessExampleWithWarnings.java
+   ```
+   This will result in two errors:
+   ```
+   docs/examples/NullnessExampleWithWarnings.java:24: error: [assignment.type.incompatible] incompatible types in assignment.
+        foo = bar;
+              ^
+     found   : @Nullable String
+     required: @NonNull String
+   docs/examples/NullnessExampleWithWarnings.java:34: error: [argument.type.incompatible] incompatible argument for parameter arg0 of List.add.
+        foo.add(quux);
+                ^
+     found   : @Nullable String
+     required: @NonNull String
+   2 errors
+   ```
+
+There is a lot more to explore!
+
+Please see the EISOP Checker Framework manual
+([HTML](https://eisop.github.io/cf/manual/),
+[PDF](https://eisop.github.io/cf/manual/checker-framework-manual.pdf))
+to learn about all the different type systems, how to integrate them into your build system, and much more.
+
+## Developers
+
+Developer notes are in [docs/developer](docs/developer),
+including a [Developer Manual](https://htmlpreview.github.io/?https://github.com/eisop/checker-framework/blob/master/docs/developer/developer-manual.html).
+
+Import the EISOP Checker Framework source folder into your IDE of choice.
+See the [IDE configuration](https://htmlpreview.github.io/?https://github.com/eisop/checker-framework/blob/master/docs/developer/developer-manual.html#IDE_configuration) section for notes.
+
+To run all test cases, run:
+```
+./gradlew alltests
+```
+
+There are many AI assistants that might help you navigate the source code, for example
+[DeepWiki](https://deepwiki.com/eisop/checker-framework/).
+
+Contributions are always welcome!
+For guidelines, see the [Contributing summary](CONTRIBUTING.md) and the
+[Contributing](https://eisop.github.io/cf/manual/#contributing)
+section in the manual.