├── .gitignore ├── .gitattributes ├── .editorconfig ├── Makefile.toml ├── .github ├── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md ├── CONTRIBUTING.md └── workflows │ └── ci.yml ├── CHANGELOG.md ├── README.md ├── src ├── meson.toml └── cmake.toml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | temp/ 3 | **/*.log 4 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text eol=lf 2 | *.ico binary 3 | *.woff binary 4 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | end_of_line = lf 7 | insert_final_newline = true 8 | trim_trailing_whitespace = true 9 | indent_style = space 10 | indent_size = 2 11 | 12 | -------------------------------------------------------------------------------- /Makefile.toml: -------------------------------------------------------------------------------- 1 | 2 | [config] 3 | skip_core_tasks = true 4 | 5 | [tasks.default] 6 | alias = "ci" 7 | 8 | [tasks.ci] 9 | category = "CI" 10 | description = "Runs CI flow" 11 | script = ''' 12 | #!@duckscript 13 | files = glob_array ./src/*.toml 14 | for file in ${files} 15 | exec --fail-on-error cargo make --list-all-steps --makefile ${file} 16 | end 17 | release ${files} 18 | ''' 19 | 20 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: sagiegurari 7 | 8 | --- 9 | 10 | ### Feature Description 11 | 12 | 13 | ### Describe The Solution You'd Like 14 | 15 | 16 | ### Code Sample 17 | 18 | ```toml 19 | # paste code here 20 | ``` 21 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | ## Issues 4 | 5 | Found a bug? Got a question? Want some enhancement?
6 | First place to go is the repository issues section, and I'll try to help as much as possible. 7 | 8 | ## Pull Requests 9 | 10 | Fixed a bug or just want to provided additional functionality?
11 | Simply fork this repository, implement your changes and create a pull request.
12 | Please make sure to provide documentation as part of your changes. 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: sagiegurari 7 | 8 | --- 9 | 10 | ### Describe The Bug 11 | 12 | 13 | ### To Reproduce 14 | 15 | 16 | ### Error Stack 17 | 18 | ```console 19 | The error message 20 | ``` 21 | 22 | ### Code Sample 23 | 24 | ```toml 25 | # paste code here 26 | ``` 27 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## CHANGELOG 2 | 3 | ### v0.1.5 (2021-09-21) 4 | 5 | * Performance - skip rust specific cargo-make steps from being invoked 6 | 7 | ### v0.1.4 (2021-08-11) 8 | 9 | * Ensure to setup env before running any task in cmake.toml 10 | 11 | ### v0.1.3 (2021-06-25) 12 | 13 | * Add new mason toml #1 (thanks @TiceCosmos) 14 | * New CI flow 15 | 16 | ### v0.1.2 (2021-03-30) 17 | 18 | * Improve performance by removing redundant make calls. 19 | * Add dev task to alias of default. 20 | 21 | ### v0.1.1 (2021-03-30) 22 | 23 | * Ensure make is called only once for all valgrind tests and not for each file 24 | 25 | ### v0.1.0 (2021-03-30) 26 | 27 | * Initial Release 28 | 29 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: [push, pull_request] 3 | env: 4 | CLICOLOR_FORCE: 1 5 | jobs: 6 | ci: 7 | name: CI 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Checkout 11 | uses: actions/checkout@v2 12 | - name: Install rust 13 | uses: actions-rs/toolchain@v1 14 | with: 15 | toolchain: stable 16 | profile: minimal 17 | override: true 18 | - name: Install cargo-make 19 | uses: actions-rs/cargo@v1 20 | with: 21 | command: install 22 | args: --debug cargo-make 23 | - name: Run CI 24 | uses: actions-rs/cargo@v1 25 | with: 26 | command: make 27 | args: ci 28 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cargo-make-tasks 2 | 3 | [![Release](https://img.shields.io/github/v/release/sagiegurari/cargo-make-tasks)](https://github.com/sagiegurari/cargo-make-tasks/releases) 4 | [![license](https://img.shields.io/github/license/sagiegurari/cargo-make-tasks)](https://github.com/sagiegurari/cargo-make-tasks/blob/master/LICENSE) 5 | 6 | > Reusable makefiles for [cargo-make](https://sagiegurari.github.io/cargo-make/). 7 | 8 | * [Overview](#overview) 9 | * [Usage](#usage) 10 | * [Contributing](.github/CONTRIBUTING.md) 11 | * [Release History](CHANGELOG.md) 12 | * [License](#license) 13 | 14 | 15 | ## Overview 16 | The cargo-make-tasks repository contains [makefiles](https://github.com/sagiegurari/cargo-make/blob/master/src/lib/descriptor/makefiles/) with tasks specific for a programing language or environment.
17 | While cargo-make comes with many built in tasks, those are either generic tasks (such as git actions) or specific for rust (such as cargo actions).
18 | However, this repository aims to provide additional tasks that can be used as is for projects that have different requirements. 19 | 20 | 21 | 22 | The following example Makefile.toml does the following: 23 | 24 | * Pulls the cmake.toml from the cargo-make-tasks repository 25 | * Pulls several generic tomls from cargo-make repository (build-file, git, github and toml) 26 | * Loads all makefiles so all tasks defined in them are now available 27 | 28 | ```toml 29 | # Include the requested makefile (in this example, cmake.toml) and optionally also 30 | # other generic makefiles from cargo-make directly. 31 | extend = [ 32 | { path = "./target/cargo-make/build-file.toml" }, 33 | { path = "./target/cargo-make/git.toml" }, 34 | { path = "./target/cargo-make/github.toml" }, 35 | { path = "./target/cargo-make/toml.toml" }, 36 | { path = "./target/cargo-make/cmake.toml" } 37 | ] 38 | 39 | [config] 40 | load_script = ''' 41 | #!@duckscript 42 | # setup directory for external makefiles 43 | mkdir ./target/cargo-make 44 | 45 | # load the makefile from the cargo-make-tasks repository (in this example, cmake.toml) 46 | file = set cmake 47 | file_path = set ./target/cargo-make/${file}.toml 48 | if not is_file ${file_path} 49 | content = http_client --method GET https://raw.githubusercontent.com/sagiegurari/cargo-make-tasks/master/src/${file}.toml 50 | writefile ${file_path} ${content} 51 | end 52 | 53 | # Optionally, load additional generic makefiles from cargo-make repository 54 | files = array build-file git github toml 55 | for file in ${files} 56 | file_path = set ./target/cargo-make/${file}.toml 57 | if not is_file ${file_path} 58 | content = http_client --method GET https://raw.githubusercontent.com/sagiegurari/cargo-make/master/src/lib/descriptor/makefiles/${file}.toml 59 | writefile ${file_path} ${content} 60 | end 61 | end 62 | release ${files} 63 | ''' 64 | ``` 65 | 66 | ## Contributing 67 | See [contributing guide](.github/CONTRIBUTING.md) 68 | 69 | 70 | ## Release History 71 | 72 | See [Changelog](CHANGELOG.md) 73 | 74 | 75 | ## License 76 | Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license. 77 | -------------------------------------------------------------------------------- /src/meson.toml: -------------------------------------------------------------------------------- 1 | 2 | [config] 3 | skip_core_tasks = true 4 | skip_rust_env_info = true 5 | skip_crate_env_info = true 6 | 7 | [env] 8 | CARGO_MAKE_MESON_BUILDDIR = "./target/debug" 9 | CARGO_MAKE_MESON_BUILDTYPE = "debug" 10 | CARGO_MAKE_MESON_ARGS = "-Db_coverage=true" 11 | 12 | [env.production] 13 | CARGO_MAKE_MESON_BUILDDIR = "./target/release" 14 | CARGO_MAKE_MESON_BUILDTYPE = "release" 15 | 16 | [tasks.default] 17 | alias = "build" 18 | 19 | [tasks.setup] 20 | description = "Setups mason and project dependencies." 21 | category = "Development" 22 | private = true 23 | dependencies = ["install-meson", "clean-gcda"] 24 | condition = { files_not_exist = ["${CARGO_MAKE_MESON_BUILDDIR}/build.ninja"] } 25 | command = "meson" 26 | args = ["setup", "--buildtype=${CARGO_MAKE_MESON_BUILDTYPE}", "@@split(CARGO_MAKE_MESON_ARGS, )", "${CARGO_MAKE_MESON_BUILDDIR}"] 27 | 28 | [tasks.build] 29 | description = "Runs mason compile to build the project." 30 | category = "Build" 31 | dependencies = ["setup"] 32 | command = "meson" 33 | args = ["compile", "-C", "${CARGO_MAKE_MESON_BUILDDIR}", "${@}"] 34 | 35 | [tasks.test] 36 | description = "Runs tests." 37 | category = "Test" 38 | dependencies = ["setup"] 39 | command = "meson" 40 | args = ["test", "-C", "${CARGO_MAKE_MESON_BUILDDIR}", "-v", "${@}"] 41 | 42 | [tasks.bench] 43 | description = "Runs benchmark tests." 44 | category = "Test" 45 | dependencies = ["setup"] 46 | command = "meson" 47 | args = ["test", "-C", "${CARGO_MAKE_MESON_BUILDDIR}", "--benchmark", "-v", "${@}"] 48 | 49 | [tasks.linter] 50 | description = "Runs linter." 51 | category = "Test" 52 | dependencies = ["build"] 53 | command = "ninja" 54 | args = ["-C", "${CARGO_MAKE_MESON_BUILDDIR}", "clang-tidy"] 55 | 56 | [tasks.scan-build] 57 | description = "Runs ninja scan-build command." 58 | category = "Build" 59 | dependencies = ["build"] 60 | command = "ninja" 61 | args = ["-C", "${CARGO_MAKE_MESON_BUILDDIR}", "scan-build"] 62 | 63 | [tasks.scan-view] 64 | description = "Runs scan-view command." 65 | category = "Build" 66 | command = "scan-view" 67 | args = ["--allow-all-hosts", "--host", "0.0.0.0", "${@}"] 68 | 69 | [tasks.coverage] 70 | description = "Generates coverage report." 71 | category = "Test" 72 | dependencies = ["test"] 73 | command = "ninja" 74 | args = ["-C", "${CARGO_MAKE_MESON_BUILDDIR}", "coverage-html"] 75 | 76 | [tasks.deps] 77 | description = "Creates dependencies graph file." 78 | category = "Development" 79 | dependencies = ["setup"] 80 | script_runner = "@duckscript" 81 | script = ''' 82 | output = exec --fail-on-error ninja -C ${CARGO_MAKE_MESON_BUILDDIR} -t graph 83 | writefile ./target/deps.dot ${output.stdout} 84 | ''' 85 | 86 | [tasks.reconfigure] 87 | description = "Runs meson reconfigure." 88 | category = "Development" 89 | dependencies = ["setup"] 90 | command = "meson" 91 | args = ["setup", "--reconfigure", "${CARGO_MAKE_MESON_BUILDDIR}", "${@}"] 92 | 93 | [tasks.install] 94 | description = "Runs meson install." 95 | category = "Development" 96 | dependencies = ["setup"] 97 | command = "meson" 98 | args = ["install", "-C", "${CARGO_MAKE_MESON_BUILDDIR}", "${@}"] 99 | 100 | [tasks.clean-gcda] 101 | description = "Deletes all gcda files." 102 | category = "Development" 103 | script = ''' 104 | #!@duckscript 105 | 106 | build_dir = canonicalize ${CARGO_MAKE_MESON_BUILDDIR} 107 | gcda_files = glob_array ${build_dir}/**/*.gcda 108 | for path in ${gcda_files} 109 | rm ${path} 110 | end 111 | ''' 112 | 113 | [tasks.install-meson] 114 | description = "Installs meson." 115 | category = "Development" 116 | install_script = ''' 117 | #!@duckscript 118 | 119 | mesonpath = which meson 120 | if is_empty ${mesonpath} 121 | pip3 install meson 122 | end 123 | ''' 124 | -------------------------------------------------------------------------------- /src/cmake.toml: -------------------------------------------------------------------------------- 1 | 2 | [config] 3 | skip_core_tasks = true 4 | skip_rust_env_info = true 5 | skip_crate_env_info = true 6 | 7 | [tasks.setup-env] 8 | description = "Sets up environment variables." 9 | category = "Development" 10 | private = true 11 | env.CARGO_MAKE_CMAKE_TARGET_DIRECTORY = "${CARGO_MAKE_WORKING_DIRECTORY}/target" 12 | env.CARGO_MAKE_CMAKE_BINARY_DIRECTORY = "${CARGO_MAKE_CMAKE_TARGET_DIRECTORY}/bin" 13 | env.CARGO_MAKE_CMAKE_TEST_FILE_PATTERN = "test_*" 14 | env.CARGO_MAKE_CMAKE_TEST_BINARY_MODE = "Release" 15 | env.CARGO_MAKE_VALGRIND_ARGS_LOCAL = "--leak-check=yes --undef-value-errors=no --error-exitcode=1" 16 | env.CARGO_MAKE_VALGRIND_ARGS_CI = "--leak-check=full --show-leak-kinds=definite,indirect,possible --error-exitcode=1" 17 | env.CARGO_MAKE_VALGRIND_ARGS = { source = "${CARGO_MAKE_CI}", default_value = "${CARGO_MAKE_VALGRIND_ARGS_LOCAL}", mapping = { "true" = "${CARGO_MAKE_VALGRIND_ARGS_CI}" } } 18 | env.CARGO_MAKE_CMAKE_DELETE_CORE_FILES = true 19 | env.CARGO_MAKE_CMAKE_UNCRUSTIFY_COMMAND = "uncrustify" 20 | env.CARGO_MAKE_CMAKE_USE_VALGRIND_MEMORY_TEST = { value = false, condition = { env_not_set = "CARGO_MAKE_CMAKE_USE_VALGRIND_MEMORY_TEST" } } 21 | env.CARGO_MAKE_CMAKE_RUN_MEMORY_CHECKS = { source = "${CARGO_MAKE_CI}", default_value = "false", mapping = { "true" = "true" } } 22 | script = ''' 23 | #!@duckscript 24 | args = split ${CARGO_MAKE_TASK_ARGS} " " 25 | 26 | for arg in ${args} 27 | if not is_empty ${arg} 28 | if eq "${arg}" --memcheck 29 | set_env CARGO_MAKE_CMAKE_RUN_MEMORY_CHECKS true 30 | end 31 | end 32 | end 33 | 34 | release ${args} 35 | ''' 36 | 37 | [tasks.default] 38 | alias = "dev" 39 | 40 | [tasks.dev] 41 | clear = true 42 | description = "Default task points to the development testing flow" 43 | category = "Development" 44 | dependencies = [ 45 | "setup-env", 46 | "format", 47 | "build", 48 | "test-flow" 49 | ] 50 | 51 | [tasks.ci-flow] 52 | description = "CI task will run all steps." 53 | category = "CI" 54 | env = { CARGO_MAKE_CI = true } 55 | run_task = "ci-flow-post-env" 56 | 57 | [tasks.ci-flow-post-env] 58 | description = "CI task will run all steps." 59 | category = "CI" 60 | private = true 61 | dependencies = [ 62 | "setup-env", 63 | "clean", 64 | "format", 65 | "build", 66 | "test-flow" 67 | ] 68 | 69 | [tasks.clean-target] 70 | description = "Cleanup the old build output and cmake generated scripts." 71 | category = "Development" 72 | private = true 73 | dependencies = ["setup-env"] 74 | script = ''' 75 | #!@duckscript 76 | rm -Rf ${CARGO_MAKE_CMAKE_TARGET_DIRECTORY} 77 | ''' 78 | 79 | [tasks.clean-core-files] 80 | description = "Deletes all core files." 81 | category = "Development" 82 | private = true 83 | condition = { env_true = ["CARGO_MAKE_CMAKE_DELETE_CORE_FILES"] } 84 | script = ''' 85 | #!@duckscript 86 | rm ./core 87 | rm ./${CARGO_MAKE_CMAKE_BINARY_DIRECTORY}/core 88 | ''' 89 | 90 | [tasks.clean-flow] 91 | description = "Cleanup the old build output and cmake generated scripts." 92 | category = "Development" 93 | dependencies = ["clean-target", "clean-core-files"] 94 | 95 | [tasks.clean] 96 | alias = "clean-flow" 97 | 98 | [tasks.prepare] 99 | description = "Sets up the target directory." 100 | category = "Development" 101 | private = true 102 | dependencies = ["setup-env"] 103 | script = ''' 104 | #!@duckscript 105 | mkdir ${CARGO_MAKE_CMAKE_TARGET_DIRECTORY} 106 | ''' 107 | 108 | [tasks.cmake] 109 | description = "Runs cmake to generate the make files." 110 | category = "Build" 111 | dependencies = ["prepare"] 112 | cwd = "${CARGO_MAKE_CMAKE_TARGET_DIRECTORY}" 113 | command = "cmake" 114 | args = [".."] 115 | 116 | [tasks.make] 117 | description = "Runs make to build the project." 118 | category = "Build" 119 | dependencies = ["cmake"] 120 | cwd = "${CARGO_MAKE_CMAKE_TARGET_DIRECTORY}" 121 | command = "make" 122 | 123 | [tasks.build] 124 | alias = "make" 125 | 126 | [tasks.format] 127 | description = "Runs uncrustify via make target." 128 | category = "Development" 129 | dependencies = ["cmake"] 130 | cwd = "${CARGO_MAKE_CMAKE_TARGET_DIRECTORY}" 131 | command = "make" 132 | args = ["uncrustify"] 133 | 134 | [tasks.pre-test] 135 | category = "Test" 136 | 137 | [tasks.test] 138 | description = "Runs tests." 139 | category = "Test" 140 | dependencies = ["make"] 141 | cwd = "${CARGO_MAKE_CMAKE_TARGET_DIRECTORY}" 142 | command = "ctest" 143 | args = ["-C", "${CARGO_MAKE_CMAKE_TEST_BINARY_MODE}", "--output-on-failure"] 144 | 145 | [tasks.post-test] 146 | category = "Test" 147 | 148 | [tasks.test-memory] 149 | description = "Runs memory tests." 150 | category = "Test" 151 | dependencies = ["setup-env"] 152 | run_task = [ 153 | { name = "valgrind-all-flow", condition = { env_true = ["CARGO_MAKE_CMAKE_USE_VALGRIND_MEMORY_TEST"] } }, 154 | { name = "cmake-memcheck" }, 155 | ] 156 | 157 | [tasks.test-memory-conditioned] 158 | description = "Runs memory tests if conditions are set." 159 | category = "Test" 160 | private = true 161 | condition = { env_true = ["CARGO_MAKE_CMAKE_RUN_MEMORY_CHECKS"] } 162 | dependencies = ["make"] 163 | run_task = "test-memory" 164 | 165 | [tasks.cmake-memcheck] 166 | description = "Runs memory tests." 167 | category = "Test" 168 | dependencies = ["cmake"] 169 | cwd = "${CARGO_MAKE_CMAKE_TARGET_DIRECTORY}" 170 | command = "ctest" 171 | args = ["-T", "memcheck"] 172 | 173 | [tasks.valgrind-file] 174 | description = "Runs valgrind memory checks for the provided file." 175 | category = "Test" 176 | private = true 177 | condition = { env_set = ["CARGO_MAKE_VALGRIND_TEST_FILE"] } 178 | cwd = "${CARGO_MAKE_CMAKE_BINARY_DIRECTORY}" 179 | command = "valgrind" 180 | args = ["@@split(CARGO_MAKE_VALGRIND_ARGS, )", "./${CARGO_MAKE_VALGRIND_TEST_FILE}"] 181 | 182 | [tasks.pre-valgrind-all] 183 | category = "Test" 184 | 185 | [tasks.valgrind-all] 186 | description = "Runs valgrind memory checks on all test files." 187 | category = "Test" 188 | private = true 189 | condition = { env_set = ["CARGO_MAKE_CMAKE_BINARY_DIRECTORY", "CARGO_MAKE_CMAKE_TEST_FILE_PATTERN"] } 190 | script = ''' 191 | #!@duckscript 192 | files = glob_array ${CARGO_MAKE_CMAKE_BINARY_DIRECTORY}/${CARGO_MAKE_CMAKE_TEST_FILE_PATTERN} 193 | 194 | for file in ${files} 195 | echo ----------------------------------- 196 | file = basename ${file} 197 | echo Running Valgrind For File: ${file} 198 | set_env CARGO_MAKE_VALGRIND_TEST_FILE ${file} 199 | cm_run_task valgrind-file 200 | echo ----------------------------------- 201 | end 202 | 203 | release ${files} 204 | ''' 205 | 206 | [tasks.post-valgrind-all] 207 | category = "Test" 208 | 209 | [tasks.valgrind-all-flow] 210 | description = "Runs valgrind memory checks on all test files." 211 | category = "Test" 212 | dependencies = [ 213 | "prepare", 214 | "pre-valgrind-all", 215 | "valgrind-all", 216 | "post-valgrind-all" 217 | ] 218 | 219 | [tasks.test-flow] 220 | description = "Runs the entire test flow." 221 | category = "Test" 222 | dependencies = [ 223 | "prepare", 224 | "pre-test", 225 | "test", 226 | "test-memory-conditioned", 227 | "post-test" 228 | ] 229 | 230 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------