Skip to content

Add support for errorprone 2.24.1 static analysis tool and Github Action to check for issues reported #4

Add support for errorprone 2.24.1 static analysis tool and Github Action to check for issues reported

Add support for errorprone 2.24.1 static analysis tool and Github Action to check for issues reported #4

Workflow file for this run

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
name: Error Prone Analysis
on:
push:
branches: [ main, add-errorprone ]
pull_request:
branches: [ main, '4.20' ]
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
permissions:
contents: read
jobs:
errorprone:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: Set up JDK 11
uses: actions/setup-java@v4
with:
java-version: '11'
distribution: 'adopt'
architecture: x64
cache: maven
- name: Run Error Prone Static Analysis (Strict Mode)
run: |
echo "::group::Error Prone Analysis"
# Temporarily remove -XepAllErrorsAsWarnings to run in strict mode
sed -i 's/-Xplugin:ErrorProne -XepAllErrorsAsWarnings/-Xplugin:ErrorProne/g' pom.xml
mvn clean compile -DskipTests -T$(nproc) 2>&1 | tee errorprone.log
BUILD_RESULT=$?
echo "::endgroup::"
exit $BUILD_RESULT
continue-on-error: true
- name: Check for Error Prone Issues
id: check-errors
run: |
if grep -q "error: \[" errorprone.log; then
echo "has_errors=true" >> $GITHUB_OUTPUT
echo "::error::Error Prone found issues in the code"
echo ""
echo "=== Error Prone Issues Found ==="
grep -B 2 "error: \[" errorprone.log | head -50
echo ""
# Create job summary
echo "## ⚠️ Error Prone Analysis Failed" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "Error Prone static analysis detected issues in this PR." >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "### Issues Found (first 50):" >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
grep -B 2 "error: \[" errorprone.log | head -50 >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "See the [Error Prone documentation](https://errorprone.info/) for details on each bug pattern." >> $GITHUB_STEP_SUMMARY
else
echo "has_errors=false" >> $GITHUB_OUTPUT
echo "✅ No Error Prone issues found"
# Create success summary
echo "## ✅ Error Prone Analysis Passed" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "No issues detected by Error Prone static analysis." >> $GITHUB_STEP_SUMMARY
fi
- name: Fail if errors found
if: steps.check-errors.outputs.has_errors == 'true'
run: exit 1