buildSrc/src/main/kotlin/source-license-checker.gradle.kts
author Da Risk <da_risk@geekorum.com>
Sun, 27 Apr 2025 16:19:28 -0400
changeset 57 5e249499bb3e
parent 34 ce299aacc068
permissions -rw-r--r--
ui:material2: fix some lint errors
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     1
/*
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     2
 * AboutOss is a utility library to retrieve and display
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     3
 * opensource licenses in Android applications.
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     4
 *
34
ce299aacc068 build: update license headers
Da Risk <da_risk@geekorum.com>
parents: 0
diff changeset
     5
 * Copyright (C) 2023-2025 by Frederic-Charles Barthelery.
0
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     6
 *
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     7
 * This file is part of AboutOss.
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     8
 *
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
     9
 * AboutOss is free software: you can redistribute it and/or modify
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    10
 * it under the terms of the GNU General Public License as published by
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    11
 * the Free Software Foundation, either version 3 of the License, or
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    12
 * (at your option) any later version.
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    13
 *
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    14
 * AboutOss is distributed in the hope that it will be useful,
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    17
 * GNU General Public License for more details.
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    18
 *
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    19
 * You should have received a copy of the GNU General Public License
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    20
 * along with AboutOss.  If not, see <http://www.gnu.org/licenses/>.
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    21
 */
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    22
package com.geekorum.build
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    23
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    24
/**
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    25
 * You need to define a License header file in "$rootDir/config/license/header.txt"
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    26
 * Define the following property to enable check of license headers
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    27
 *    - CHECK_LICENSE_HEADERS : true or false. default is false
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    28
 */
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    29
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    30
val checkLicenseHeadersString = findProperty("CHECK_LICENSE_HEADERS") as String?
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    31
val checkLicenseHeader =  checkLicenseHeadersString?.toBoolean() ?: false
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    32
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    33
if (checkLicenseHeader) {
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    34
    configureSourceLicenseChecker()
0a13dcabf7d3 Initial commit
fbarthelery <darisk972@gmail.com>
parents:
diff changeset
    35
}