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

📖 Improve the REUSE parts of the License check #4155

Merged
merged 5 commits into from
Jun 12, 2024

Conversation

mxmehl
Copy link
Contributor

@mxmehl mxmehl commented Jun 7, 2024

What kind of change does this PR introduce?

This PR contains three changes concerning the REUSE part of the License check:

  • Improve a link
  • Fix the LICENSES directory name
  • Clarify where the tool looks for license text files

The third point needs your review as I am not certain how the tool checks for license files. As the docs also recommend putting license files in LICENSES, this SHOULD be the case.

What is the current behavior?

What is the new behavior (if this is a feature change)?**

The check documentation and the recommendations are unclear and partly misleading.

Which issue(s) this PR fixes

NONE

Special notes for your reviewer

Does this PR introduce a user-facing change?

NONE

@mxmehl mxmehl marked this pull request as draft June 7, 2024 07:45
@mxmehl mxmehl force-pushed the licensing-check-clarifications branch from fc335ab to 5a35ab5 Compare June 7, 2024 07:48
Signed-off-by: Max Mehl <mail@mehl.mx>
Signed-off-by: Max Mehl <mail@mehl.mx>
@mxmehl mxmehl force-pushed the licensing-check-clarifications branch from 5a35ab5 to a4a33a0 Compare June 7, 2024 07:50
@mxmehl mxmehl marked this pull request as ready for review June 7, 2024 07:51
Copy link
Member

@spencerschrock spencerschrock left a comment

Choose a reason for hiding this comment

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

Can you run make generate-docs and commit the changes to docs/checks.md?

docs/checks/internal/checks.yaml is the correct place to make changes, but the markdown needs to be generated too.

@mxmehl
Copy link
Contributor Author

mxmehl commented Jun 9, 2024

Can you run make generate-docs and commit the changes to docs/checks.md?

docs/checks/internal/checks.yaml is the correct place to make changes, but the markdown needs to be generated too.

Sure, done, sorry for not doing that in the first place.

@spencerschrock
Copy link
Member

Can you run make generate-docs and commit the changes to docs/checks.md?
docs/checks/internal/checks.yaml is the correct place to make changes, but the markdown needs to be generated too.

Sure, done, sorry for not doing that in the first place.

Thanks! You'll need to fix your DCO on your last commit and then we can merge. https://github.com/ossf/scorecard/pull/4155/checks?check_run_id=25990600837

Signed-off-by: Max Mehl <mail@mehl.mx>
@mxmehl mxmehl force-pushed the licensing-check-clarifications branch from c75342a to 8fb1005 Compare June 12, 2024 09:25
@mxmehl
Copy link
Contributor Author

mxmehl commented Jun 12, 2024

Thanks! You'll need to fix your DCO on your last commit and then we can merge. #4155 (checks)

Whoops, done, thanks!

@spencerschrock spencerschrock enabled auto-merge (squash) June 12, 2024 16:12
@spencerschrock spencerschrock merged commit fcdc63b into ossf:main Jun 12, 2024
36 checks passed
@mxmehl mxmehl deleted the licensing-check-clarifications branch June 14, 2024 07:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants