| <!--- |
| 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 |
| |
| asflicense |
| |
| ## Category |
| |
| Test |
| |
| ## Description |
| |
| Runs the [Apache Creadur](http://creadur.apache.org) project's [Rat](http://creadur.apache.org/rat/) code to verify software licensing. |
| Currently, `ant`, `gradle`, and `maven` have built-in support. The Apache Yetus container image also provides the jar file in /opt/apache-rat. |
| For other build tools/scenarios, the rat jar will need to be provided. |
| |
| ## Environment Variables |
| |
| None |
| |
| ## Options |
| |
| | Option | Notes | |
| | :--------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | |
| | `--asflicense-rat-excludes=<path>` | When running rat outside of a build tool, specify the location of the exclusion file | |
| | `--asflicense-rat-globalexcludes=<bool>` | Apply the global excludes file after Apache Rat has run (default: true) | |
| | `--asflicense-rat-jar=<path>` | When running rat outside of a build tool, specify the location of the Java jar file to execute. Defaults to /opt/apache-rat/apache-rat.jar | |
| |
| ## Docker Notes |
| |
| None |
| |
| ## Developer Notes |
| |
| None |
