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 #2746

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

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e63e164
kie-issues#1613: Add apache-rat check github action
jomarko Nov 15, 2024
571eab2
remove checkstyle.header.template
jomarko Nov 15, 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/pr-rat-check.yml
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

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

Please name this ci_check_license_headers.yaml

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: Run Apache RAT check
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
name: Run Apache RAT check
name: CI :: Check license headers


on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
Comment on lines +22 to +24
Copy link
Contributor

Choose a reason for hiding this comment

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

I think making it run on merges to main would be good too... We can use the same triggers we have for ci_build.yaml


jobs:
apache-rat-check:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
apache-rat-check:
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
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we should be using a SNAPSHOT version.


- 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."
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,3 +346,7 @@ turbo.json
# IntelliJ projects should be on _intellij-projects folder, never on specific packages.
packages/*/.idea
examples/*/.idea


# Apache RAT check excludes file
!.rat-excludes
79 changes: 79 additions & 0 deletions .rat-excludes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
### general excludes
**/*.iml
**/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
**/licenses/**

### kie-tools specific excludes
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is probably most complicated repository we have, what I need from reviewers is to help with finalization of the exclude patterns, once done and we are sure all what is needed is excluded from 'apache-rat-check', I will fix those files == add license there.

**/patches/**
**/node_modules/**
**/dist/**
**/dist-dev/**
**/dist-tests/**
**/dist-tests-e2e/**
**/tests-data/**
**/ts-gen/**
**/python-venv/**
*devbox.lock
*pnpm-lock.yaml
*pnpm-workspace.yaml
**/*.d.ts
**/examples/**
**/tests/__fixtures__/**
**/tests/**/__fixtures__/**
**/tests/__snapshots__/**
**/tests/**/__snapshots__/**
**/e2e-tests/fixtures/**
**/e2e-tests/**/fixtures/**
**/e2e-tests/resources/**
**/e2e-tests/**/resources/**
**/tests-e2e/__fixtures__/**
**/tests/inputFiles/**
**/tests/expectedResults/**
**/tests/test-workspace/**
**/tests/**/resources/**
**/test-resources/tests/**
**/testdata/**
**/__screenshots__/**
*.iml
*.patch
**/graph.dot
*.wid
**/Chart.lock
*.base64png
**/check-junit-report-results/tests/reports/empty.xml
**/dev-deployment-upload-service/tests/test.zip
**/dmn-editor/src/spec.txt
**/drools-wb-scenario-simulation-editor-kogito-marshaller/src/main/java/**
**/errai-ui/src/test/**/*.less
**/errai-ui/src/test/**/*.html
**/form-code-generator-bootstrap4-theme/src/resources/staticCode/**
**/form-code-generator-bootstrap4-theme/src/resources/templates/**
**/form-code-generator-patternfly-theme/src/resources/**
**/fonts/OpenSans*
**/fonts/fontawesome*
**/generated-parser/*
**/kie-editors-standalone/resources/**/*.template
**/kie-wb-common-dmn/kie-wb-common-dmn-webapp-kogito-marshaller/src/main/java**
**/kie-wb-common-stunner-bpmn-emf/**
**/kie-sandbox-helm-chart/**/templates/**
**/runtime-tools-consoles-helm-chart/**/templates/**
**/serverless-workflow-standalone-editor/resources/**/*.template
**/schemas/dmn*/*.xsd
**/schemas/bpmn*/*.xsd
**/templates/*.ftl
**/third_party/gwtbootstrap3/**
**/uniforms-bootstrap4-codegen/src/resources/staticCode/**
**/uniforms-bootstrap4-codegen/src/resources/templates/**
**/uniforms-patternfly-codegen/src/resources/**
**/vscode-java-code-completion-extension-plugin-core/src/main/resources/templates/**
**/xml-parser-ts-codegen/**/*.xsd
28 changes: 0 additions & 28 deletions packages/dashbuilder/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,30 +116,6 @@
<version.antrun.plugin>1.8</version.antrun.plugin>
<version.exec-maven-plugin>3.0.0</version.exec-maven-plugin>
<version.org.maven.dependency.plugin>3.1.2</version.org.maven.dependency.plugin>
<checkstyle.header.extensions>java</checkstyle.header.extensions>
<checkstyle.header.template
><![CDATA[
^\/\*$\n^
\* Licensed to the Apache Software Foundation \(ASF\) under one$\n^
\* or more contributor license agreements\. See the NOTICE file$\n^
\* distributed with this work for additional information$\n^
\* regarding copyright ownership\. The ASF licenses this file$\n^
\* to you under the Apache License, Version 2\.0 \(the$\n^
\* &quot;License&quot;\); you may not use this file except in compliance$\n^
\* with the License\. You may obtain a copy of the License at$\n^
\*$\n^
\* http:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0$\n^
\*$\n^
\* Unless required by applicable law or agreed to in writing,$\n^
\* software distributed under the License is distributed on an$\n^
\* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY$\n^
\* KIND, either express or implied\. See the License for the$\n^
\* specific language governing permissions and limitations$\n^
\* under the License\.$\n^
\*\/$
]]>
</checkstyle.header.template>

<!-- Properties from DROOLS-WB parent POM -->
<!-- TODO: Enable these flags after fixing all checkstyle issues -->
<checkstyle.failOnViolation>true</checkstyle.failOnViolation>
Expand Down Expand Up @@ -1191,10 +1167,6 @@
</module>
<module name="EqualsHashCode" />
</module>
<module name="RegexpHeader">
<property name="header" value="${checkstyle.header.template}" />
<property name="fileExtensions" value="${checkstyle.header.extensions}" />
</module>
</module>
</checkstyleRules>
<outputFile>${project.build.directory}/checkstyle.log</outputFile>
Expand Down
27 changes: 0 additions & 27 deletions packages/serverless-workflow-diagram-editor/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,28 +135,6 @@
<!-- Properties from KIE-WB-COMMON parent POM -->

<spotbugs.failOnViolation>true</spotbugs.failOnViolation>
<checkstyle.header.template
><![CDATA[
^\/\*$\n^
\* Licensed to the Apache Software Foundation \(ASF\) under one$\n^
\* or more contributor license agreements\. See the NOTICE file$\n^
\* distributed with this work for additional information$\n^
\* regarding copyright ownership\. The ASF licenses this file$\n^
\* to you under the Apache License, Version 2\.0 \(the$\n^
\* &quot;License&quot;\); you may not use this file except in compliance$\n^
\* with the License\. You may obtain a copy of the License at$\n^
\*$\n^
\* http:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0$\n^
\*$\n^
\* Unless required by applicable law or agreed to in writing,$\n^
\* software distributed under the License is distributed on an$\n^
\* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY$\n^
\* KIND, either express or implied\. See the License for the$\n^
\* specific language governing permissions and limitations$\n^
\* under the License\.$\n^
\*\/$
]]>
</checkstyle.header.template>

<!-- Properties from DROOLS-WB parent POM -->
<!-- TODO: Enable these flags after fixing all checkstyle issues -->
Expand All @@ -177,7 +155,6 @@
<!--suppress UnresolvedMavenProperty -->
<project.root.dir>${maven.multiModuleProjectDirectory}</project.root.dir>
<jacoco.exec.file>${project.root.dir}/target/jacoco.exec</jacoco.exec.file>
<checkstyle.header.extensions>java</checkstyle.header.extensions>

<!-- Maven Plugins -->
<version.antrun.plugin>1.8</version.antrun.plugin>
Expand Down Expand Up @@ -807,10 +784,6 @@
</module>
<module name="EqualsHashCode" />
</module>
<module name="RegexpHeader">
<property name="header" value="${checkstyle.header.template}" />
<property name="fileExtensions" value="${checkstyle.header.extensions}" />
</module>
</module>
</checkstyleRules>
<outputFile>${project.build.directory}/checkstyle.log</outputFile>
Expand Down
27 changes: 0 additions & 27 deletions packages/stunner-editors/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,28 +162,6 @@
<!-- Properties from KIE-WB-COMMON parent POM -->

<spotbugs.failOnViolation>true</spotbugs.failOnViolation>
<checkstyle.header.template
><![CDATA[
^\/\*$\n^
\* Licensed to the Apache Software Foundation \(ASF\) under one$\n^
\* or more contributor license agreements\. See the NOTICE file$\n^
\* distributed with this work for additional information$\n^
\* regarding copyright ownership\. The ASF licenses this file$\n^
\* to you under the Apache License, Version 2\.0 \(the$\n^
\* &quot;License&quot;\); you may not use this file except in compliance$\n^
\* with the License\. You may obtain a copy of the License at$\n^
\*$\n^
\* http:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0$\n^
\*$\n^
\* Unless required by applicable law or agreed to in writing,$\n^
\* software distributed under the License is distributed on an$\n^
\* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY$\n^
\* KIND, either express or implied\. See the License for the$\n^
\* specific language governing permissions and limitations$\n^
\* under the License\.$\n^
\*\/$
]]>
</checkstyle.header.template>

<!-- Properties from DROOLS-WB parent POM -->
<!-- TODO: Enable these flags after fixing all checkstyle issues -->
Expand All @@ -204,7 +182,6 @@
<!--suppress UnresolvedMavenProperty -->
<project.root.dir>${maven.multiModuleProjectDirectory}</project.root.dir>
<jacoco.exec.file>${project.root.dir}/target/jacoco.exec</jacoco.exec.file>
<checkstyle.header.extensions>java</checkstyle.header.extensions>

<!-- Maven Plugins -->
<version.antrun.plugin>1.8</version.antrun.plugin>
Expand Down Expand Up @@ -920,10 +897,6 @@
</module>
<module name="EqualsHashCode" />
</module>
<module name="RegexpHeader">
<property name="header" value="${checkstyle.header.template}" />
<property name="fileExtensions" value="${checkstyle.header.extensions}" />
</module>
</module>
</checkstyleRules>
<outputFile>${project.build.directory}/checkstyle.log</outputFile>
Expand Down
Loading