Skip to content

build: add CI check for outdated documentation #2430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

build: add CI check for outdated documentation #2430

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d51a37a
Add CI check for outdated documentation
mbutrovich Sep 20, 2025
7d8cd6a
Merge branch 'main' into ci_check_docs
mbutrovich Sep 22, 2025
0cc16df
Try again.
mbutrovich Sep 22, 2025
1ec48e1
Try again.
mbutrovich Sep 22, 2025
e0033eb
Merge branch 'main' into ci_check_docs
mbutrovich Sep 24, 2025
5f2aca0
Use @andygrove's approach.
mbutrovich Sep 24, 2025
1514296
Merge branch 'main' into ci_check_docs
mbutrovich Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/actions/java-test/action.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,24 @@ runs:
run: |
./mvnw -B compile test-compile scalafix:scalafix -Dscalafix.mode=CHECK -Psemanticdb ${{ inputs.maven_opts }}

- name: Check for documentation changes
shell: bash
run: |
# Configure git for safe directory access in container
git config --global --add safe.directory "$(pwd)"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems overly complex. I think we can just run a git diff to see if there are local changes?

ChatGPT suggested:

 - name: Fail if there are uncommitted changes
        run: |
          if ! git diff --quiet || ! git diff --cached --quiet; then
            echo "❌ Found uncommitted changes after build/format"
            git status
            git diff
            exit 1
          fi

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems overly complex.

That's Claude for you! I'll give your suggestion a shot, thanks!


# Force regenerate docs by running just the package phase to ensure GenerateDocs runs
echo "Running Maven package to regenerate documentation..."
./mvnw package -DskipTests -q -pl spark

# Check if there are any uncommitted changes after build/format
if ! git diff --quiet || ! git diff --cached --quiet; then
echo "Found uncommitted changes after build/format"
git status
git diff
exit 1
fi

- name: Run all tests
shell: bash
if: ${{ inputs.suites == '' }}
Expand All @@ -82,6 +100,7 @@ runs:
MAVEN_SUITES="$(echo "${{ inputs.suites }}" | paste -sd, -)"
echo "Running with MAVEN_SUITES=$MAVEN_SUITES"
MAVEN_OPTS="-Xmx4G -Xms2G -DwildcardSuites=$MAVEN_SUITES -XX:+UnlockDiagnosticVMOptions -XX:+ShowMessageBoxOnError -XX:+HeapDumpOnOutOfMemoryError -XX:ErrorFile=./hs_err_pid%p.log" SPARK_HOME=`pwd` ./mvnw -B clean install ${{ inputs.maven_opts }}

- name: Upload crash logs
if: failure()
uses: actions/upload-artifact@v4
Expand Down
Loading