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

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

Merged
merged 10 commits into from
Nov 20, 2024

Conversation

jomarko
Copy link
Contributor

@jomarko jomarko commented Oct 10, 2024

This is partial fix for apache/incubator-kie-issues#1613. We open one PR per repository.

Referenced pull requests

Checklist

  • Documentation updated if applicable.
  • Release notes updated if applicable.
  • Upgrade recipe provided if applicable.
How to replicate CI configuration locally?

Build Chain tool does "simple" maven build(s), the builds are just Maven commands, but because the repositories relates and depends on each other and any change in API or class method could affect several of those repositories there is a need to use build-chain tool to handle cross repository builds and be sure that we always use latest version of the code for each repository.

build-chain tool is a build tool which can be used on command line locally or in Github Actions workflow(s), in case you need to change multiple repositories and send multiple dependent pull requests related with a change you can easily reproduce the same build by executing it on Github hosted environment or locally in your development environment. See local execution details to get more information about it.

How to retest this PR or trigger a specific build:
  • for pull request checks
    Please add comment: Jenkins retest this

  • for a specific pull request check
    please add comment: Jenkins (re)run [optaplanner|optaplanner-quickstarts] tests

  • for a full downstream build

    • for jenkins job:
      please add comment: Jenkins run fdb
    • for github actions job:
      add the label run_fdb
  • for a compile downstream build
    please add comment: Jenkins run cdb

  • for a full production downstream build
    please add comment: Jenkins execute product fdb

  • for an upstream build
    please add comment: Jenkins run upstream

  • for quarkus branch checks
    Run checks against Quarkus current used branch
    Please add comment: Jenkins run quarkus-branch

  • for a quarkus branch specific check
    Run checks against Quarkus current used branch
    Please add comment: Jenkins (re)run [optaplanner|optaplanner-quickstarts] quarkus-branch

  • for quarkus main checks
    Run checks against Quarkus main branch
    Please add comment: Jenkins run quarkus-main

  • for a specific quarkus main check
    Run checks against Quarkus main branch
    Please add comment: Jenkins (re)run [optaplanner|optaplanner-quickstarts] quarkus-branch

  • for quarkus lts checks
    Run checks against Quarkus lts branch
    Please add comment: Jenkins run quarkus-lts

  • for a specific quarkus lts check
    Run checks against Quarkus lts branch
    Please add comment: Jenkins (re)run [optaplanner|optaplanner-quickstarts] quarkus-lts

  • for native checks
    Run native checks
    Please add comment: Jenkins run native

  • for a specific native check
    Run native checks
    Please add comment: Jenkins (re)run [optaplanner|optaplanner-quickstarts] native

  • for native lts checks
    Run native checks against quarkus lts branch
    Please add comment: Jenkins run native-lts

  • for a specific native lts check
    Run native checks against quarkus lts branch
    Please add comment: Jenkins (re)run [optaplanner|optaplanner-quickstarts] native-lts

CI Status

You can check OptaPlanner repositories CI status from Chain Status webpage.

How to backport a pull request to a different branch?

In order to automatically create a backporting pull request please add one or more labels having the following format backport-<branch-name>, where <branch-name> is the name of the branch where the pull request must be backported to (e.g., backport-7.67.x to backport the original PR to the 7.67.x branch).

NOTE: backporting is an action aiming to move a change (usually a commit) from a branch (usually the main one) to another one, which is generally referring to a still maintained release branch. Keeping it simple: it is about to move a specific change or a set of them from one branch to another.

Once the original pull request is successfully merged, the automated action will create one backporting pull request per each label (with the previous format) that has been added.

If something goes wrong, the author will be notified and at this point a manual backporting is needed.

NOTE: this automated backporting is triggered whenever a pull request on main branch is labeled or closed, but both conditions must be satisfied to get the new PR created.

@jomarko
Copy link
Contributor Author

jomarko commented Nov 14, 2024

This will be addressed via apache/incubator-kie-issues#1613

@jomarko jomarko closed this Nov 14, 2024
@jomarko jomarko reopened this Nov 15, 2024
@jomarko jomarko changed the title NO-ISSUE: Add license header [incubator-kie-issues#1613] Add license header Nov 15, 2024
@jomarko jomarko changed the title [incubator-kie-issues#1613] Add license header incubator-kie-issues#1613: Add license header Nov 15, 2024
@jomarko jomarko changed the title incubator-kie-issues#1613: Add license header kie-issues#1613: Add CI :: Check license headers GitHub Actions workflow Nov 18, 2024
NOTICE Outdated
Comment on lines 11 to 19
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

LICENSE.txt Outdated Show resolved Hide resolved
@jomarko
Copy link
Contributor Author

jomarko commented Nov 20, 2024

@tkobayas thank you for the help, changes pushed

NOTICE Outdated
Comment on lines 1 to 9
Apache KIE
Copyright 2024 The Apache Software Foundation

This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).

The Initial Developer of some parts of the framework, which are copied from, derived from, or
inspired by KIE (Knowledge Is Everthing) group, is Red Hat, Inc (https://www.redhat.com/).
Copyright Red Hat, Inc. and/or its affiliates.. All Rights Reserved.
Copy link
Contributor

Choose a reason for hiding this comment

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

@jomarko Ahh, I'm sorry that I confused you. I wanted to say we can remove the items for third party components. But we need to keep the main notice about Apache KIE. So the result would be like the same as https://github.com/apache/incubator-kie-drools/blob/main/NOTICE , not removing the whole file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@tkobayas sorry, my fault, I added the NOTICE file back

jomarko added a commit to jomarko/optaplanner that referenced this pull request Nov 27, 2024
…kflow (apache#3130)

* Add license header

* Revert "Add license header"

This reverts commit be404f1.

* .rat-excludes

* align naming with kie-issues#1613 ensemble

* moce licenses into single file

* LICENSE.txt -> LICENSE

* Remove NOTICE

* Add jstree, jquery in .rat-excludes

* NOTICE recreated
jomarko added a commit that referenced this pull request Dec 2, 2024
…tions workflow (#3147)

* kie-issues#1613: Add `CI :: Check license headers` GitHub Actions workflow (#3130)

* Add license header

* Revert "Add license header"

This reverts commit be404f1.

* .rat-excludes

* align naming with kie-issues#1613 ensemble

* moce licenses into single file

* LICENSE.txt -> LICENSE

* Remove NOTICE

* Add jstree, jquery in .rat-excludes

* NOTICE recreated

* kie-issues#1613: Migrate `CI :: Check license headers`  apache-rat v0.16.1 (#3144)

* Add license header

* .rat-excludes

* align naming with kie-issues#1613 ensemble

* moce licenses into single file

* LICENSE.txt -> LICENSE

* Remove NOTICE

* Add jstree, jquery in .rat-excludes

* NOTICE recreated

* List explicitely all files in the .rat-exclude

* Use apache-rat v0.16.1

* CI :: License headers
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants