-
Notifications
You must be signed in to change notification settings - Fork 245
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.
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
Conversation
Ensure that PRs include necessary documentation updates when config defaults change. The check runs after Maven build (which generates docs from config values) and fails if any docs files are modified, indicating missing documentation changes. Fixes apache#2427 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
I could test this by submitting a PR with a branch based on a commit before #2428 |
Looking at #2433, I don't think it worked correctly. |
echo "Please run 'make jvm' locally and commit the updated documentation files." | ||
exit 1 | ||
else | ||
echo "✅ Documentation is up-to-date" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super minor nitpick to probably remove the emojis
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I'll clean it up. Not impressed by my first Claude PR considering it also doesn't seem to work.
echo "Checking documentation consistency..." | ||
# Configure git for safe directory access in container | ||
git config --global --add safe.directory "$(pwd)" |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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!
Punting on this for now. |
Which issue does this PR close?
Closes #2427.
Rationale for this change
We want to make sure configs.md is in sync with the code.
What changes are included in this PR?
CI check to diff the docs folder after building.
How are these changes tested?
N/A
Co-Authored-By: Claude [email protected]