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

add license check #861

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

Conversation

stan-dot
Copy link
Contributor

Fixes #825

Copy link

codecov bot commented Oct 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.58%. Comparing base (e673dbf) to head (8fbd3bf).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #861   +/-   ##
=======================================
  Coverage   95.58%   95.58%           
=======================================
  Files         125      125           
  Lines        5419     5419           
=======================================
  Hits         5180     5180           
  Misses        239      239           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@stan-dot stan-dot marked this pull request as ready for review October 23, 2024 16:34
@stan-dot stan-dot force-pushed the 825-add-a-github-action-for-licensing-compliance-checker-testing-for-the-python-copier-template-purposes branch from 23fc5a4 to 5326bfe Compare October 23, 2024 16:34
@DiamondJoseph
Copy link
Contributor

This is only run on release- shouldn't we be checking during the PR to add the dependency?

@stan-dot
Copy link
Contributor Author

good question @DiamondJoseph

I'd say yes the footwork should be done beforehand. The license check in the release is more just for a sanity check, it does not need to happen at the early stage.

two layers > one

@stan-dot stan-dot force-pushed the 825-add-a-github-action-for-licensing-compliance-checker-testing-for-the-python-copier-template-purposes branch from 5326bfe to d74761c Compare October 24, 2024 10:32
@stan-dot stan-dot added enhancement New feature or request github_actions Pull requests that update GitHub Actions code python Pull requests that update Python code low priority Not needed for production in the near future labels Oct 24, 2024
@DiamondJoseph
Copy link
Contributor

DiamondJoseph commented Oct 24, 2024

What I mean @stan-dot is that this action should be run during the PR, not that it should be part of the review process. If we add a dependency that is not licensed, then we make use of it it'll be difficult to extract after the fact. I'd expect this PR to have triggered a new check so that we could see if we are not already non-compliant.

@stan-dot
Copy link
Contributor Author

fair enough @DiamondJoseph , where exactly do you consider it is best to run it then? before the lint? after the test?

@DiamondJoseph
Copy link
Contributor

It's independent of those, it's just another workflow to be run. Make it a new _license.yml in .github/workflows and add it to run alongside lint and test in ci.yml

@coretl
Copy link
Collaborator

coretl commented Oct 25, 2024

This doesn't appear to be working, there is no license.json uploaded as an artifact from the job...

@DiamondJoseph
Copy link
Contributor

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request github_actions Pull requests that update GitHub Actions code low priority Not needed for production in the near future python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a github action for licensing compliance checker (testing for the python-copier-template purposes)
3 participants