Showing
1 changed file
with
114 additions
and
0 deletions
OAT.xml
0 → 100644
| 1 | +<?xml version="1.0" encoding="UTF-8"?> | ||
| 2 | +<!-- Copyright (c) 2021 Huawei Device Co., Ltd. | ||
| 3 | + | ||
| 4 | + Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 5 | + you may not use this file except in compliance with the License. | ||
| 6 | + You may obtain a copy of the License at | ||
| 7 | + | ||
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 | ||
| 9 | + | ||
| 10 | + Unless required by applicable law or agreed to in writing, software | ||
| 11 | + distributed under the License is distributed on an "AS IS" BASIS, | ||
| 12 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 13 | + See the License for the specific language governing permissions and | ||
| 14 | + limitations under the License. | ||
| 15 | + | ||
| 16 | + This is the configuration file template for OpenHarmony OSS Audit Tool, please copy it to your project root dir and modify it refer to OpenHarmony/tools_oat/README. | ||
| 17 | + All configurations in this file will be merged to OAT-Default.xml, if you have any questions or concerns, please create issue in OpenHarmony/tools_oat and @jalenchen or chenyaxun. | ||
| 18 | + | ||
| 19 | + licensefile: | ||
| 20 | + 1.If the project don't have "LICENSE" in root dir, please define all the license files in this project in , OAT will check license files according to this rule. | ||
| 21 | + | ||
| 22 | + policylist: | ||
| 23 | + 1. policy: If the OAT-Default.xml policies do not meet your requirements, please add policies here. | ||
| 24 | + 2. policyitem: The fields type, name, path, desc is required, and the fields rule, group, filefilter is optional,the default value is: | ||
| 25 | + <policyitem type="" name="" path="" desc="" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter"/> | ||
| 26 | + 3. policyitem type: | ||
| 27 | + "compatibility" is used to check license compatibility in the specified path; | ||
| 28 | + "license" is used to check source license header in the specified path; | ||
| 29 | + "copyright" is used to check source copyright header in the specified path; | ||
| 30 | + "import" is used to check source dependency in the specified path, such as import ... ,include ... | ||
| 31 | + "filetype" is used to check file type in the specified path, supported file types: archive, binary | ||
| 32 | + "filename" is used to check whether the specified file exists in the specified path(projectroot means the root dir of the project), supported file names: LICENSE, README, README.OpenSource | ||
| 33 | + 4. policyitem name: This field is used for define the license, copyright, "*" means match all, the "!" prefix means could not match this value. For example, "!GPL" means can not use GPL license. | ||
| 34 | + 5. policyitem path: This field is used for define the source file scope to apply this policyitem, the "!" prefix means exclude the files. For example, "!.*/lib/.*" means files in lib dir will be exclude while process this policyitem. | ||
| 35 | + 6. policyitem rule and group: These two fields are used together to merge policy results. "may" policyitems in the same group means any one in this group passed, the result will be passed. | ||
| 36 | + 7. policyitem filefilter: Used to bind filefilter which define filter rules. | ||
| 37 | + 7. policyitem desc: Used to describe the reason of this policy item, committers will check this while merging the code. | ||
| 38 | + 8. filefilter: Filter rules, the type filename is used to filter file name, the type filepath is used to filter file path. | ||
| 39 | + | ||
| 40 | + Note:If the text contains special characters, please escape them according to the following rules: | ||
| 41 | + " == " | ||
| 42 | + & == & | ||
| 43 | + ' == ' | ||
| 44 | + < == < | ||
| 45 | + > == > | ||
| 46 | +--> | ||
| 47 | + | ||
| 48 | +<configuration> | ||
| 49 | + <oatconfig> | ||
| 50 | + <licensefile></licensefile> | ||
| 51 | + <policylist> | ||
| 52 | + <policy | ||
| 53 | + desc="" | ||
| 54 | + name="projectPolicy"> | ||
| 55 | + <policyitem | ||
| 56 | + desc="Developed By OpenValley Digital Co., Ltd." | ||
| 57 | + filefilter="copyrightPolicyFilter" | ||
| 58 | + group="defaultGroup" | ||
| 59 | + name="Hunan OpenValley Digital Industry Development Co., Ltd." | ||
| 60 | + path=".*" | ||
| 61 | + rule="may" | ||
| 62 | + type="copyright"/> | ||
| 63 | + <policyitem | ||
| 64 | + desc="Developed By The Flutter Authors. All rights reserved." | ||
| 65 | + filefilter="copyrightPolicyFilter" | ||
| 66 | + group="defaultGroup" | ||
| 67 | + name="The Flutter Authors. All rights reserved" | ||
| 68 | + path=".*" | ||
| 69 | + rule="may" | ||
| 70 | + type="copyright"/> | ||
| 71 | + <policyitem type="license" name="BSD-3-Clause" path=".*" filefilter="defaultPolicyFilter" desc="不影响兼容性"/> | ||
| 72 | + <policyitem type="license" name="BSD 3-Clause License" path=".*" filefilter="defaultPolicyFilter" desc="不影响兼容性"/> | ||
| 73 | + <policyitem type="license" name="BSD-2-Clause" path=".*" filefilter="defaultPolicyFilter" desc="不影响兼容性"/> | ||
| 74 | + <policyitem type="license" name="BSD 2-Clause License" path=".*" filefilter="defaultPolicyFilter" desc="不影响兼容性"/> | ||
| 75 | + <policyitem type="compatibility" name="BSD-3-Clause" path=".*" desc="不影响兼容性"/> | ||
| 76 | + <policyitem type="compatibility" name="BSD-2-Clause" path=".*" desc="不影响兼容性"/> | ||
| 77 | + <policyitem type="license" name="BSDStyleLicense" path=".*" filefilter="defaultPolicyFilter" desc="不影响兼容性"/> | ||
| 78 | + </policy> | ||
| 79 | + <policy name="projectPolicy" desc=""> | ||
| 80 | + <policyitem type="compatibility" name="GPL-2.0+" path=".*" desc="Process that runs independently, invoked by the X process."/> | ||
| 81 | + <policyitem type="compatibility" name="Apache-2.0" path=".*" desc="不影响兼容性"/> | ||
| 82 | + <policyitem type="compatibility" name="BSDStyleLicense" path=".*" desc="不影响兼容性" /> | ||
| 83 | + </policy> | ||
| 84 | + </policylist> | ||
| 85 | + | ||
| 86 | + <filefilterlist> | ||
| 87 | + <filefilter name="defaultFilter" desc="Files not to check"> | ||
| 88 | + <filteritem type="filename" name="*.iml|*.json|*.txt" desc="desc files"/> | ||
| 89 | + <filteritem type="filename" name="*.png|*.ico|*.jpg|*.webp|*.ttf|*.enc|*.mp3" desc="app resource files"/> | ||
| 90 | + <filteritem type="filename" name="*.so|*.har" desc="engine二进制文件,不影响兼容性"/> | ||
| 91 | + <filteritem type="filename" name="*.tgz" desc="hvigor本地插件,不影响兼容性"/> | ||
| 92 | + <filteritem type="filepath" name="*/ohos/har/" desc="hvigor本地插件,不影响兼容性"/> | ||
| 93 | + <filteritem type="filepath" name="*/ohos/entry/src/main/resources/rawfile/flutter_assets/" desc="资源文件，不影响兼容性"/> | ||
| 94 | + <filteritem type="filepath" name="*/ohos/dta/icudtl.dat" desc="ohos字体库文件，不影响兼容性"/> | ||
| 95 | + <filteritem type="filepath" name="*/ohos/hvigor/hvigor-wrapper.js" desc="hvigorw编译程序，不影响兼容性"/> | ||
| 96 | + <filteritem type="filepath" name="*/ohos/hvigorw.bat" desc="hvigorw编译程序，不影响兼容性"/> | ||
| 97 | + </filefilter> | ||
| 98 | + <filefilter name="defaultPolicyFilter" desc="Filters for compatibility，license header policies"> | ||
| 99 | + <filteritem type='filepath' name="packages/pigeon/example/app/ohos/entry/src/main/ets/plugins/Messages.ets" desc='BSDStyleLicense,不影响兼容性'/> | ||
| 100 | + </filefilter> | ||
| 101 | + <filefilter name="copyrightPolicyFilter" desc="Filters for copyright header policies"> | ||
| 102 | + </filefilter> | ||
| 103 | + <filefilter name="licenseFileNamePolicyFilter" desc="Filters for LICENSE file policies"> | ||
| 104 | + </filefilter> | ||
| 105 | + <filefilter name="readmeFileNamePolicyFilter" desc="Filters for README file policies"> | ||
| 106 | + </filefilter> | ||
| 107 | + <filefilter name="readmeOpenSourcefileNamePolicyFilter" desc="Filters for README.OpenSource file policies"> | ||
| 108 | + </filefilter> | ||
| 109 | + <filefilter name="binaryFileTypePolicyFilter" desc="Filters for binary file policies"> | ||
| 110 | + <filteritem type="filename" name="*.iml|*.json|*.txt" desc="desc files"/> | ||
| 111 | + </filefilter> | ||
| 112 | + </filefilterlist> | ||
| 113 | + </oatconfig> | ||
| 114 | +</configuration> |
-
Please register or login to post a comment