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

kie-issues#1613: Add CI :: Check license headers GitHub Actions workflow #3130

Merged
merged 10 commits into from
Nov 20, 2024
Merged

kie-issues#1613: Add CI :: Check license headers GitHub Actions workflow #3130

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
be404f1
Add license header
jomarko Oct 10, 2024
b1e6bf1
Merge remote-tracking branch 'upstream/main' into optaplanner-license
jomarko Nov 15, 2024
fc5a16d
Revert "Add license header"
jomarko Nov 15, 2024
7a78976
.rat-excludes
jomarko Nov 15, 2024
575b722
align naming with kie-issues#1613 ensemble
jomarko Nov 18, 2024
c4974db
moce licenses into single file
jomarko Nov 18, 2024
5b40428
LICENSE.txt -> LICENSE
jomarko Nov 20, 2024
a70b708
Remove NOTICE
jomarko Nov 20, 2024
e6e0645
Add jstree, jquery in .rat-excludes
jomarko Nov 20, 2024
595392c
NOTICE recreated
jomarko Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/workflows/ci_check_license_headers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#

name: "CI :: Check license headers"

on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]

jobs:
check-license-headers:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Download Apache RAT
run: |
curl -LO https://repository.apache.org/content/repositories/snapshots/org/apache/rat/apache-rat/0.17-SNAPSHOT/apache-rat-0.17-20241115.065104-374.jar

- name: Run Apache RAT
run: |
java -jar apache-rat-0.17-20241115.065104-374.jar --input-exclude-file .rat-excludes -- . > .tmp-rat-check-output
cat .tmp-rat-check-output
grep "Files with unapproved licenses:" .tmp-rat-check-output && rm .tmp-rat-check-output && echo "There are files with missing or unapproved license headers." && exit 1 || rm .tmp-rat-check-output && echo "All files have correct license headers."
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,6 @@

# Repository wide ignore mac DS_Store files
.DS_Store

# Apache RAT check excludes file
!.rat-excludes
21 changes: 21 additions & 0 deletions .rat-excludes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### general excludes
**/target/**
**/.*
*README*
*readme*
DISCLAIMER-WIP
**/src/test/resources/**
**/src/test/filtered-resources/**
**/*integration-test*/src/main/resources/**
**/**example**/**/resources/**
**/META-INF/services/**
**/META-INF/beans.xml

### optaplanner specific excludes
**/optaplanner-examples/data/**/import/**
**/eclipse.importorder
**/src/main/resources/org/optaplanner/benchmark/impl/report/twitterbootstrap/css/**
**/src/main/resources/org/optaplanner/benchmark/impl/report/twitterbootstrap/img/**
**/src/main/resources/org/optaplanner/benchmark/impl/report/twitterbootstrap/js/**
**/benchmark.xsd
**/solver.xsd
59 changes: 59 additions & 0 deletions LICENSE.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,3 +200,62 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

------------------------------------------------------------------------------------------------------------------
for optaplanner-benchmark/src/main/resources/org/optaplanner/benchmark/impl/report/twitterbootstrap/css/bootstrap*
optaplanner-benchmark/src/main/resources/org/optaplanner/benchmark/impl/report/twitterbootstrap/img/**
optaplanner-benchmark/src/main/resources/org/optaplanner/benchmark/impl/report/twitterbootstrap/js/bootstrap*

The MIT License (MIT)

Copyright (c) 2011-2019 Twitter, Inc.
Copyright (c) 2011-2019 The Bootstrap Authors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

--------------------------------------------------------------------------------------------------------------
for optaplanner-benchmark/src/main/resources/org/optaplanner/benchmark/impl/report/twitterbootstrap/js/jquery*

Copyright OpenJS Foundation and other contributors, https://openjsf.org/

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

--------------------------------------------------------------------------------------------------------------------
for optaplanner-benchmark/src/main/resources/org/optaplanner/benchmark/impl/report/twitterbootstrap/css/prettify.css
optaplanner-benchmark/src/main/resources/org/optaplanner/benchmark/impl/report/twitterbootstrap/js/prettify.js

(https://github.com/googlearchive/code-prettify)
http://www.apache.org/licenses/LICENSE-2.0
jomarko marked this conversation as resolved.
Show resolved Hide resolved
12 changes: 0 additions & 12 deletions NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,10 @@ Copyright Red Hat, Inc. and/or its affiliates.. All Rights Reserved.

This product also includes the following third-party components:

* Twitter bootstrap version: 2.3.2
Downloaded from: https://getbootstrap.com/
License: Apache License v2.0 (just like OptaPlanner)

* jQuery version: 1.9.1
Downloaded from: http://jquery.com/
License: MIT (which can be used by Apache License v2.0 projects)

* google-code-pretty version: 4-Mar-2013
Downloaded from: http://code.google.com/p/google-code-prettify
License: Apache License v2.0 (just like OptaPlanner)

* jQuery version: 3.3.1
Downloaded from: http://jquery.com/
License: MIT - this is compatible with ASL 2.0: http://www.apache.org/legal/resolved.html#category-a

* jstree version: 3.3.5
Downloaded from: https://www.jstree.com/
License: MIT - this is compatible with ASL 2.0: http://www.apache.org/legal/resolved.html#category-a
Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you for the great work, @jomarko !

As mentioned in apache/incubator-kie-issues#1616 (comment) , NOTICE file only contains contents of NOTICE files of the third-party components.

I confirmed that the repositories below don't have NOTICE files, so we can simply remove these items from our NOTICE file.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also please add jstree to LICENSE file. (If optaplanner-docs is excluded from source distribution using the release CI, we don't even need to add this to LICENSE)

optaplanner-docs/src/modules/ROOT/images/website/jstree/32px.png
optaplanner-docs/src/modules/ROOT/images/website/jstree/40px.png
optaplanner-docs/src/modules/ROOT/images/website/jstree/jstree.js
optaplanner-docs/src/modules/ROOT/images/website/jstree/jstree.min.js
optaplanner-docs/src/modules/ROOT/images/website/jstree/style.css
optaplanner-docs/src/modules/ROOT/images/website/jstree/throbber.gif

Copy link
Contributor Author

Choose a reason for hiding this comment

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

optaplanner-docs is included in the source distribution. I will add corresponding entry into LICENSE for the jstree

Loading