KAFKA-18241: add docs check to CI #18183
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
triage
chia7712
reviewed
Dec 14, 2024
.github/workflows/build.yml
Outdated
| # Check if there are any empty files under ./site-docs/generated, If any empty files are found, print an error | ||
| # message and list the empty files | ||
| run: | | ||
| ./gradlew clean siteDocTar |
There was a problem hiding this comment.
It should not call clean, as doing so prevents subsequent steps from accessing the output of the previous build. Perhaps we should merge the siteDocTar task into the preceding step, and this step verify the contents of the generated documentation files.
mumrah
reviewed
Dec 16, 2024
.github/workflows/build.yml
Outdated
| @@ -118,6 +118,13 @@ jobs: | |||
| # --no-scan: For public fork PRs, we won't attempt to publish the scan | |||
| run: | | |||
| ./gradlew --build-cache --info $SCAN_ARG check -x test | |||
| ./gradlew siteDocTar | |||
There was a problem hiding this comment.
I think @chia7712's comment was to move the siteDocTar into this "Compile and validate" and add a subsequent step to verify the contents (e.g., "Check Site Docs"). Having two gradle commands in one step makes it harder to see what failed without digging into the logs.
mumrah
requested changes
Dec 18, 2024
.github/workflows/build.yml
Outdated
| @@ -137,6 +137,17 @@ jobs: | |||
| run: python .github/scripts/rat.py | |||
| env: | |||
| GITHUB_WORKSPACE: ${{ github.workspace }} | |||
| - name: Check generated documentation | |||
| if: always() | |||
There was a problem hiding this comment.
Hm, always() means this will run even if a previous step failed. Maybe we should remove this so the step is not run in the event that the "Compile and validate" step fails.
.github/workflows/build.yml
Outdated
Comment on lines
147
to
149
| echo "One or more documentation files are empty!" >&2 | ||
| find ./site-docs/generated -type f -exec grep -L "." {} \; >&2 | ||
| exit 1 |
There was a problem hiding this comment.
Can you indent the if body by 2 spaces?
ijuma
added a commit
to ijuma/kafka
that referenced
this pull request
Dec 19, 2024
…e-old-protocol-versions * apache-github/trunk: (25 commits) KAFKA-18270: FindCoordinator v0 incorrectly tagged as deprecated (apache#18262) KAFKA-18284: Add group coordinator records for Streams rebalance protocol (apache#18228) MINOR: Fix flaky state updater test (apache#18253) MINOR: improve StreamsResetter logging (apache#18237) KAFKA-18227: Ensure v2 partitions are not added to last transaction during upgrade (apache#18176) Add IT for share consumer with duration base offet auto reset (apache#18251) KAFKA-18283: Add StreamsGroupDescribe RPC definitions (apache#18230) KAFKA-18241: add docs check to CI (apache#18183) KAFKA-18223 Improve flaky test report (apache#18212) MINOR Remove triage label in nightly job (apache#18147) KAFKA-18294 Remove deprecated SourceTask#commitRecord (apache#18260) KAFKA-18264 Remove NotLeaderForPartitionException (apache#18211) KAFKA-13722: Refactor SerdeGetter (apache#18242) KAFKA-18094 Remove deprecated TopicListing(String, Boolean) (apache#18248) KAFKA-18282: Add StreamsGroupHeartbeat RPC definitions (apache#18227) KAFKA-18026: KIP-1112 migrate KTableSuppressProcessorSupplier (apache#18150) KAFKA-18026: transition KTable#filter impl to use processor wrapper (apache#18205) KAFKA-18293 Remove `org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerLoginCallbackHandler` and `org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerValidatorCallbackHandler` (apache#18244) MINOR: add assertion about groupEpoch and targetAssignmentEpoch to testConsumerGroups (apache#18203) KAFKA-17960; PlaintextAdminIntegrationTest.testConsumerGroups fails with CONSUMER group protocol (apache#18234) ...
tedyu
pushed a commit
to tedyu/kafka
that referenced
this pull request
Jan 6, 2025
Reviewers: Chia-Ping Tsai <[email protected]>, David Arthur <[email protected]>
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Jira: https://issues.apache.org/jira/browse/KAFKA-18241
We missed to check generated document in CI, thus we should test this
Committer Checklist (excluded from commit message)