-
Notifications
You must be signed in to change notification settings - Fork 178
Add license PR checks + how to run it locally #1235
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
Conversation
@@ -103,6 +103,22 @@ If you decide to use a different license for your work, follow the same pattern: | |||
|
|||
- If more than one license applies to the source file, use an SPDX license expression (see [SPDX Specification, Appendix IV](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60)), to reflect the presence of multiple licenses in your *LICENSE.md* file and in each source file. | |||
|
|||
## License check in pull requests | |||
|
|||
We use scancode-toolkit to enforce the license in binaries and libraries. Please see "Continuous integration (CI) testing" section for more information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can move Please see "Continuous integration (CI) testing" section for more information.
to the end of this section, shall I?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm agnostic on this one.
The pull request adding license check using scancode was merged to master. This can progress (as the checks are being active from today for all PRs). |
docs/contributing/guidelines/ci.md
Outdated
@@ -24,7 +24,7 @@ Travis configuration is located in the [.travis.yml](https://github.com/ARMmbed/ | |||
- Features/netsocket. | |||
- **travis-ci/events** - Checks that Mbed OS compiles and run events tests. | |||
- **travis-ci/gitattributestest** - Checks there are no changes after clone. This checks that `.gitattributes` is used correctly. | |||
- **travis-ci/licence_check** - Checks there is no GPL license text in the code. | |||
- **travis-ci/licence_check** - Checks there is only permissive license in files, including SPDX identifier. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
only a permissive license in the files,
@@ -103,6 +103,22 @@ If you decide to use a different license for your work, follow the same pattern: | |||
|
|||
- If more than one license applies to the source file, use an SPDX license expression (see [SPDX Specification, Appendix IV](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60)), to reflect the presence of multiple licenses in your *LICENSE.md* file and in each source file. | |||
|
|||
## License check in pull requests | |||
|
|||
We use scancode-toolkit to enforce the license in binaries and libraries. Please see "Continuous integration (CI) testing" section for more information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm agnostic on this one.
|
||
We use scancode-toolkit to enforce the license in binaries and libraries. Please see "Continuous integration (CI) testing" section for more information. | ||
|
||
To scan the files in SCANCODE folder, please use: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in the
Updated, fixed the above requested changes |
docs/contributing/guidelines/ci.md
Outdated
@@ -24,7 +24,7 @@ Travis configuration is located in the [.travis.yml](https://github.com/ARMmbed/ | |||
- Features/netsocket. | |||
- **travis-ci/events** - Checks that Mbed OS compiles and run events tests. | |||
- **travis-ci/gitattributestest** - Checks there are no changes after clone. This checks that `.gitattributes` is used correctly. | |||
- **travis-ci/licence_check** - Checks there is no GPL license text in the code. | |||
- **travis-ci/licence_check** - Checks only a permissive license in the files, including SPDX identifier. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think i missed a bit:
Checks that there is only a permissive license in the files,
Fixed as well |
da2e050
to
6e6478a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR 👍
Apply changes from PR #1235 to v5.15.
Apply changes from PR #1235 to v5.15.
This depends on ARMmbed/mbed-os#12437
Once it is merged, this can go in (no release dependency, will be running on master for every PR)
I added a section to our license guide - how to run the license check
@ARMmbed/mbed-os-maintainers Please review