Skip to content
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

Jump to bottom

KAFKA-17607: Add CI step to verify LICENSE-binary #18299

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

KAFKA-17607: Add CI step to verify LICENSE-binary #18299

wants to merge 2 commits into from
+40 −0

Conversation

xijiu
Copy link
Contributor

@xijiu xijiu commented Dec 22, 2024

As title.

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

@github-actions github-actions bot added triage PRs from the community build Gradle build or GitHub Actions small Small PRs labels Dec 22, 2024
@xijiu
Copy link
Contributor Author

xijiu commented Dec 22, 2024

I added a new gradlew task libLicenseCheck, so when execute command ./gradlew clean libLicenseCheck, it will print the missing libs in license file

image

@mumrah @chia7712 @chiacyu PTAL ☺

m1a2st
m1a2st reviewed Dec 22, 2024
View reviewed changes
Copy link
Contributor

@m1a2st m1a2st left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Hello @xijiu, Thanks for this PR.
Pardon me, I have a question that this libLicenseCheck gradle task will be execute on our CI, should we add verify step on the build.yml?

@github-actions github-actions bot removed the triage PRs from the community label Dec 23, 2024
@xijiu
Copy link
Contributor Author

xijiu commented Dec 23, 2024

Hello @xijiu, Thanks for this PR. Pardon me, I have a question that this libLicenseCheck gradle task will be exected on our CI, should we add verify step on the build.yml?

@m1a2st Thanks for the CR. I have added this to the CI, PTAL

mumrah
mumrah reviewed Dec 23, 2024
View reviewed changes
Copy link
Member

@mumrah mumrah left a comment

Choose a reason for hiding this comment

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

Thanks for the patch @xijiu!

.github/workflows/build.yml
@@ -143,6 +143,9 @@ jobs:
find ./site-docs/generated -type f -exec grep -L "." {} \; >&2
exit 1
fi
- name: Check missing lib license
run: |
./gradlew libLicenseCheck
Copy link
Member

Choose a reason for hiding this comment

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

Can you add this to the previous gradlew invocation?

build.gradle
@@ -1328,6 +1328,43 @@ project(':core') {
duplicatesStrategy 'exclude'
}

task libLicenseCheck(dependsOn: 'releaseTarGz', type: Copy) {
Copy link
Member

Choose a reason for hiding this comment

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

I think it would be better to do this as part of releaseTarGz so we can't mistakenly produce an artifact that is missing licenses. I glanced through build.gradle and I don't see where we're gathering the libraries into the LICENSE file. Do you know where that happens?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m1a2st m1a2st m1a2st left review comments

@mumrah mumrah mumrah left review comments

Assignees
No one assigned
Labels
build Gradle build or GitHub Actions ci-approved small Small PRs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@xijiu @mumrah @m1a2st