Skip to content

Allow configuring if existing headers should be skipped in license check #303

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

Merged
findepi merged 1 commit into from
Mar 21, 2022
Merged

Allow configuring if existing headers should be skipped in license check #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
Airbase 124

* When checking license headers do not skip the files which already contain a
detected license header. Can be configured via `air.license.skip-existing-headers`.

Airbase 123

* Dependency update:
Expand Down
3 changes: 2 additions & 1 deletion airbase/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@
<air.license.default-value>Copyright (C) ${project.inceptionYear} ${air.license.owner}</air.license.default-value>
<air.license.ensure-match>Copyright \(C\) \d{4} .+</air.license.ensure-match>
<air.license.header-file>license/apache-header.txt</air.license.header-file>
<air.license.skip-existing-headers>false</air.license.skip-existing-headers>

<!-- Checkstyle -->
<air.checkstyle.config-file>checkstyle/airbase-checks.xml</air.checkstyle.config-file>
Expand Down Expand Up @@ -738,7 +739,7 @@
</dependencies>
<configuration>
<skip>${air.check.skip-license}</skip>
<skipExistingHeaders>true</skipExistingHeaders>
<skipExistingHeaders>${air.license.skip-existing-headers}</skipExistingHeaders>
Copy link
Copy Markdown
Contributor

@findepi findepi Mar 18, 2022

Choose a reason for hiding this comment

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

Why not always false?

Copy link
Copy Markdown
Contributor

@findepi findepi Mar 18, 2022

Choose a reason for hiding this comment

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

(it's true since ever (d71d25e))

Copy link
Copy Markdown
Contributor Author

@hashhar hashhar Mar 18, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Just to preserve compatibility. IMO it should be false.
A case where this can be important is if you have mixed license files and want to preserve original licenses.

Copy link
Copy Markdown
Contributor

@findepi findepi Mar 18, 2022

Choose a reason for hiding this comment

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

@electrum can you please chime in here?

Copy link
Copy Markdown
Member

@electrum electrum Mar 19, 2022

Choose a reason for hiding this comment

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

Let’s make this false, since that is the better default. Any projects that need to skip can set the property when updating.

Copy link
Copy Markdown
Contributor Author

@hashhar hashhar Mar 19, 2022

Choose a reason for hiding this comment

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

Updated default to true and adjusted CHANGES entry accordingly.

<failIfMissing>${air.check.fail-license}</failIfMissing>
<header>${air.license.header-file}</header>
<mapping>
Expand Down