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.

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

chore: move license generation to release phase #174

Merged
merged 1 commit into from
Feb 5, 2025
Merged

Conversation

kezhenxu94
Copy link
Member

Instead of generating LICENSE in each PR, moving this to release phase can help dependencies upgrade to be more smoothly, this PR also add a GitHub Actions step to check incompatible license as early as possible, to avoid block when doing a release.

@kezhenxu94 kezhenxu94 requested a review from wu-sheng February 5, 2025 03:29
@wu-sheng
Copy link
Member

wu-sheng commented Feb 5, 2025

So, from this, PR CI only checks the dependencies compatibility, but don't force the license comparison, am I understanding this correctly?

@kezhenxu94
Copy link
Member Author

So, from this, PR CI only checks the dependencies compatibility, but don't force the license comparison, am I understanding this correctly?

Yes, with this PR, LICENSE file and licenses/ folder will not be compared or checked, we just make sure the licenses are compatible so we can easily generate LICENSE and licenses/ without having to revert incompatible dependencies till releasing.


3. Generate LICENSE file in [`dist/LICENSE`](../../../../dist/LICENSE) and copy dependencies' licneses to [`dist/licenses`](../../../../dist/licenses/) folder, this can be done by running the following command in the project root:
```shell
license-eye dep resolve --summary dist/LICENSE.tpl -o dist/licenses
Copy link
Member

Choose a reason for hiding this comment

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

Should we consider to locking eyes version?
I am asking this, because I want this step in oap and Java agent too.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added instruction to install specific version of license-eye

@kezhenxu94 kezhenxu94 merged commit b70a465 into main Feb 5, 2025
18 checks passed
@kezhenxu94 kezhenxu94 deleted the releaselicensing branch February 5, 2025 05:10
@wu-sheng
Copy link
Member

wu-sheng commented Feb 5, 2025

Could you apply this to oap and java agent as well? It should lower the 1st contributor bar.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants