EPIC - Replace copyright headers and comments to compliance with ASF policy

[eduardocerqueira]

For the full list of repos pls see #428

TASKS

• Replace copyright headers/comments on kogito-examples as part of the migration to Apache #470
• Replace copyright headers/comments on kogito-docs as part of the migration to Apache #471
• Replace copyright headers/comments on kogito-runtimes as part of the migration to Apache #473
• Replace copyright headers/comments on kie-tools as part of the migration to Apache #500
• Kogito Runtimes enforce Copyright with Checkstyle #501
• Replace copyright headers/comments on optaplanner as part of the migration to Apache #519
• Replace copyright headers/comments on kie-benchmarks as part of the migration to Apache #500 #520
• replace copyrights header/comments in drools #531
• replace copyrights headers/comments in kogito-apps #562
• replace copyrights headers/comments in kogito-images #563
• replace copyrights headers/comments in kogito-operator #564
• replace copyrights headers/comments in kogito-website #565
• replace copyrights headers/comments in kogito-pipelines #566
• replace copyrights headers/comments in kogito-serverless-operator #567
• replace copyrights headers/comments in optaplanner-quickstarts #568
• replace copyrights headers/comments in kie-docs #569
• replace copyrights headers/comments in kogito-benchmarks #570
• replace copyrights headers/comments in kie-sandbox-quarkus-accelerator #571
• replace copyrights headers/comments in kogito-online-staging #572
• replace copyrights headers/comments in kogito-online #573

Read the instructions below and find the tasks on this epic.

What is the goal?
As part of migration kie repos to Apache, we need to remove Red Hat's copyrights and apply the ASF header [1], replacing the code header for all files, ideally all files should have ASF header, no matter the file extension.

How?
For Java maven based project, the best alternative is using license-maven-plugin [3] if the repo doesn't follow a maven base project then it is up to you, let your inspiration to drive it, perhaps creating a script would work.

sharing some tips:

• check the checkstyle configuration from your repo, it might be using the old version header so you may need to update it or update the parent version, see [4] and [5].
• some of kie.* projects were using the old maven license plugin from codehaus
• some commands to help:

mvn com.mycila:license-maven-plugin:remove
mvn com.mycila:license-maven-plugin:format
mvn checkstyle:check
grep -R --exclude-dir=target -i "Red Hat" *
grep -R --exclude-dir=target -i -E "copyright|Red Hat"

mvn license:format -Dlicense.header=licensesheader.txt
mvn -Dtest=ServerlessWorkflowCodestartTest test -DfailIfNoTests=false -Dsurefire.failIfNoSpecifiedTests=false -Dsnap

Things to check before submitting your PR

1. Before changing anyting, ensure you can build and run all tests in your local environment and they pass!
2. After replacing the headers to ASF [1] and removing Red Hat copyrights ensure your project builds and all tests are passing, so your changes didn't introduce a bug.
3. Verify checkstyle and do a last check seeking for Red Hat in your project root folder.

mvn checkstyle:check
grep -R --exclude-dir=target -i "Red Hat" *
grep -R --exclude-dir=target -i -E "copyright|Red Hat"

[1] https://www.apache.org/legal/src-headers.html#headers
[2] https://github.com/orgs/apache/projects/295/views/1?pane=issue&itemId=40502472
[3] https://mycila.carbou.me/license-maven-plugin/reports/4.2/license-maven-plugin/plugin-info.html
[4] https://github.com/apache/incubator-kie-kogito-runtimes/blob/main/kogito-build/kogito-build-no-bom-parent/pom.xml#L49
[5] https://github.com/apache/incubator-kie-kogito-runtimes/blob/main/kogito-build/kogito-build-no-bom-parent/pom.xml#L491

[porcelli]

Apache headers reference: https://www.apache.org/legal/src-headers.html

[ederign]

First dry run for ts and js files : https://github.com/kiegroup/kie-tools/pull/1919

[ederign]

Second round. TS/JS/Java/GO done https://github.com/kiegroup/kie-tools/pull/1920

KIE tools is the most complicated one. As soon as we wrap up it, we can easily do others repositories.

@porcelli splitting in small around of files/projects would mean that we would need 10's of PRs. So I've talked with Tiago, and we will do at least on KIE tools as a single shot.

[porcelli]

It's fine to me;

my concern is that a single PR will be very hard to do a proper review, so basically will end up having to trust the script at some extent.

[eduardocerqueira]

Perhaps we need more discussion to find them a better alternative for the code-review. IMO we should rely on CI for validating the changes where I assume it will run checkstyle check, compile and smoke tests

Here is the work I got completed for Kogito-examples repo. I haven't sent a PR yet as I want to get some initial feedback, pls check the commit into my forked/branch:

eduardocerqueira/kogito-examples@4055c97

summary: 1544 files changed

steps:

update licensesheader.txt with content from https://www.apache.org/legal/src-headers.html
mvn com.mycila:license-maven-plugin:remove
mvn com.mycila:license-maven-plugin:format -Dlicense.header=licensesheader.txt

[tiagobento]

On the KIE Tools side, I'm fine with a huge PR, as long as the CI is green... looking at the CI logs might be a good way to verify that everything is running as intended and the uploaded artifacts are performing as expected...

If someone really wants to skim through the files, I think downloading Eder's branch and opening a local Git tool to see the changes is a valid alternative... With that said, this is NOT how I think code reviews should be done, but since this is a one-time thing, I don't see many problems with it.

[ederign]

@eduardocerqueira @porcelli, one topic for the call tomorrow: shall I migrate other repos? Or we are going to split somehow? I saw that @eduardocerqueira started some.

[eduardocerqueira]

Hi @ederign

I got the work done -- but just need to send the PR -- for these repos below:

• https://github.com/kiegroup/kogito-runtimes
• https://github.com/kiegroup/kogito-examples
• https://github.com/kiegroup/kogito-docs

I was planning to start https://github.com/kiegroup/drools for the next week which my plan is to submit all those PRs by begin of the week.

[ederign]

ok, I'll take optaplanner and kie benchmarks (Going from the list from bottom )

[ederign]

FYI: optaplanner doesn't have RHT apache headers: ederign/optaplanner@5868098

[porcelli]

@ederign but optaplanner is moving - @mdproctor correct me if I'm wrong.

[ederign]

Yes it's moving! I wonder if we should add Apache header for all java files to keep consistency. @mdproctor wdyt?

[yesamer]

All subtasks completed!