├── images ├── gh-tmate.jpg └── template-button.png ├── docker-compose.addon-template.yaml ├── README_ADDON.md ├── README_DEBUG.md ├── install.yaml ├── README.md └── LICENSE /images/gh-tmate.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ddev/ddev-addon-template/HEAD/images/gh-tmate.jpg -------------------------------------------------------------------------------- /images/template-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ddev/ddev-addon-template/HEAD/images/template-button.png -------------------------------------------------------------------------------- /docker-compose.addon-template.yaml: -------------------------------------------------------------------------------- 1 | #ddev-generated 2 | services: 3 | addon-template: 4 | container_name: ddev-${DDEV_SITENAME}-addon-template 5 | image: ${ADDON_TEMPLATE_DOCKER_IMAGE:-ddev/ddev-utilities:latest} 6 | command: tail -f /dev/null 7 | restart: "no" 8 | # These labels ensure this service is discoverable by DDEV. 9 | labels: 10 | com.ddev.site-name: ${DDEV_SITENAME} 11 | com.ddev.approot: ${DDEV_APPROOT} 12 | 13 | volumes: 14 | - ".:/mnt/ddev_config" 15 | - "ddev-global-cache:/mnt/ddev-global-cache" 16 | -------------------------------------------------------------------------------- /README_ADDON.md: -------------------------------------------------------------------------------- 1 | [![add-on registry](https://img.shields.io/badge/DDEV-Add--on_Registry-blue)](https://addons.ddev.com) 2 | [![tests](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml?query=branch%3Amain) 3 | [![last commit](https://img.shields.io/github/last-commit/ddev/ddev-addon-template)](https://github.com/ddev/ddev-addon-template/commits) 4 | [![release](https://img.shields.io/github/v/release/ddev/ddev-addon-template)](https://github.com/ddev/ddev-addon-template/releases/latest) 5 | 6 | # DDEV Add-on Template 7 | 8 | ## Overview 9 | 10 | This add-on integrates Add-on Template into your [DDEV](https://ddev.com/) project. 11 | 12 | ## Installation 13 | 14 | ```bash 15 | ddev add-on get ddev/ddev-addon-template 16 | ddev restart 17 | ``` 18 | 19 | After installation, make sure to commit the `.ddev` directory to version control. 20 | 21 | ## Usage 22 | 23 | | Command | Description | 24 | | ------- | ----------- | 25 | | `ddev describe` | View service status and used ports for Add-on Template | 26 | | `ddev logs -s addon-template` | Check Add-on Template logs | 27 | 28 | ## Advanced Customization 29 | 30 | To change the Docker image: 31 | 32 | ```bash 33 | ddev dotenv set .ddev/.env.addon-template --addon-template-docker-image="ddev/ddev-utilities:latest" 34 | ddev add-on get ddev/ddev-addon-template 35 | ddev restart 36 | ``` 37 | 38 | Make sure to commit the `.ddev/.env.addon-template` file to version control. 39 | 40 | All customization options (use with caution): 41 | 42 | | Variable | Flag | Default | 43 | | -------- | ---- | ------- | 44 | | `ADDON_TEMPLATE_DOCKER_IMAGE` | `--addon-template-docker-image` | `ddev/ddev-utilities:latest` | 45 | 46 | ## Credits 47 | 48 | **Contributed and maintained by @CONTRIBUTOR** 49 | -------------------------------------------------------------------------------- /README_DEBUG.md: -------------------------------------------------------------------------------- 1 | # How to debug tests (Github Actions) 2 | 3 | 1. You need an SSH-key registered with GitHub. You either pick the key you have already used with `github.com` or you create a dedicated new one with `ssh-keygen -t ed25519 -a 64 -f tmate_ed25519 -C "$(date +'%d-%m-%Y')"` and add it at `https://github.com/settings/keys`. 4 | 5 | 2. Add the following snippet to `~/.ssh/config`: 6 | 7 | ``` 8 | Host *.tmate.io 9 | User git 10 | AddKeysToAgent yes 11 | UseKeychain yes 12 | PreferredAuthentications publickey 13 | IdentitiesOnly yes 14 | IdentityFile ~/.ssh/tmate_ed25519 15 | ``` 16 | 3. Go to `https://github.com///actions/workflows/tests.yml`. 17 | 18 | 4. Click the `Run workflow` button and you will have the option to select the branch to run the workflow from and activate `tmate` by checking the `Debug with tmate` checkbox for this run. 19 | 20 | ![tmate](images/gh-tmate.jpg) 21 | 22 | 5. After the `workflow_dispatch` event was triggered, click the `All workflows` link in the sidebar and then click the `tests` action in progress workflow. 23 | 24 | 7. Pick one of the jobs in progress in the sidebar. 25 | 26 | 8. Wait until the current task list reaches the `tmate debugging session` section and the output shows something like: 27 | 28 | ``` 29 | 106 SSH: ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io 30 | 107 or: ssh -i PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io 31 | 108 SSH: ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io 32 | 109 or: ssh -i PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io 33 | ``` 34 | 35 | 9. Copy and execute the first option `ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io` in the terminal and continue by pressing either q or Ctrl + c. 36 | 37 | 10. Start the Bats test with `bats ./tests/test.bats`. 38 | 39 | For a more detailed documentation about `tmate` see [Debug your GitHub Actions by using tmate](https://mxschmitt.github.io/action-tmate/). 40 | -------------------------------------------------------------------------------- /install.yaml: -------------------------------------------------------------------------------- 1 | # Details about the install.yaml file are at https://ddev.readthedocs.io/en/stable/users/extend/additional-services/#sections-and-features-of-ddev-get-add-on-installyaml 2 | 3 | name: addon-template 4 | 5 | # pre_install_actions - list of actions to run before installing the addon. 6 | # Examples would be removing an extraneous docker volume, 7 | # or doing a sanity check for requirements. 8 | # DDEV environment variables can be interpolated into these actions 9 | # pre_install_actions are executed in the context of the target project's root directory. 10 | pre_install_actions: 11 | # - | 12 | # #ddev-description:Check architecture type for incompatible arm64 type 13 | # if [ "$(uname -m)" = "arm64" -o "$(uname -m)" = "aarch64" ]; then 14 | # echo "This package does not work on arm64 (Apple Silicon) machines"; 15 | # exit 1; 16 | # fi 17 | 18 | # - "docker volume rm ddev-${DDEV_PROJECT}_solr 2>/dev/null || true" 19 | 20 | # Use this example to perform different actions based on the DDEV version. 21 | # If you only need a version constraint, use ddev_version_constraint instead (see below). 22 | # - | 23 | # #ddev-description:Show a message for v1.24.7+ 24 | # if ${DDEV_EXECUTABLE} debug match-constraint ">= 1.24.7" 2>/dev/null ; then 25 | # echo "Using DDEV v1.24.7+, running extra actions..." 26 | # fi 27 | 28 | # - 'echo "what is your platform.sh token" && read x' 29 | 30 | # This item shows templating using DDEV environment variables. 31 | # - | 32 | # #ddev-description:Touch a file to create it 33 | # touch ${DDEV_APPROOT}/.ddev/somefile.${DDEV_PROJECT_TYPE}.${DDEV_DOCROOT}.txt 34 | 35 | # This item shows complex go templating possibilities based on yaml_read_files 36 | # - | 37 | # #ddev-description:Create a config.platformsh.yaml 38 | # cat <${DDEV_APPROOT}/.ddev/config.platformsh.yaml 39 | # php_version: {{ trimPrefix "php:" .platformapp.type }} 40 | # database: 41 | # type: {{ regexReplaceAll ":.*$" .services.db.type "" }} 42 | # version: {{ regexReplaceAll "^.*:" .services.db.type "" }} 43 | 44 | # docroot: {{ dig "web" "locations" "/" "root" "notfound" .platformapp }} 45 | # {{- if eq .platformapp.build.flavor "composer" }} 46 | # hooks: 47 | # post-start: 48 | # - composer: install 49 | # {{- if .platformapp.hooks.deploy }} 50 | # - exec: "{{ trimAll "\n" .platformapp.hooks.deploy | splitList "\n" | join ` && ` }}" 51 | # {{- end }} 52 | # {{- end }} 53 | 54 | # EOF 55 | 56 | # list of files and directories listed that are copied into project .ddev directory 57 | # Each file should contain #ddev-generated so it can be replaced by a later `ddev add-on get` 58 | # if it hasn't been modified by the user. 59 | # DDEV environment variables can be interpolated into these filenames 60 | # If you use directories, they must be directories that are managed 61 | # by this add-on, or removal could remove things that are not owned by it 62 | project_files: 63 | - docker-compose.addon-template.yaml 64 | # - commands/web/add-on-command 65 | # - commands/host/add-on-command-host 66 | # - web-build/Dockerfile.addon-template 67 | # - some-directory/file1.txt 68 | # - some-directory/file2.txt 69 | # - extra_files_dir_created_by_this_template/ 70 | # - somefile.sh 71 | 72 | # List of files and directories that are copied into the global .ddev directory 73 | # DDEV environment variables can be interpolated into these filenames 74 | # Note that if these files are used by a team, you will need to automate their installation 75 | # by adding `ddev add-on get` to your workflow to ensure that everyone has them. 76 | # Otherwise, use 'project_files' to commit them to the repository. 77 | global_files: 78 | # - commands/web/add-on-command 79 | # - homeadditions/some-file.txt 80 | 81 | # Version constraint for DDEV that will be validated against the running DDEV executable 82 | # and prevent add-on from being installed if it doesn't validate. 83 | # See https://github.com/Masterminds/semver#checking-version-constraints for constraint rules. 84 | # Available with DDEV v1.23.4+, and works only for DDEV v1.23.4+ binaries 85 | ddev_version_constraint: '>= v1.24.10' 86 | 87 | # List of add-on names that this add-on depends on 88 | dependencies: 89 | # - redis 90 | 91 | # DDEV environment variables can be interpolated into these actions. 92 | # post_install_actions are executed in the context of the target project's .ddev directory. 93 | post_install_actions: 94 | # - chmod +x ~/.ddev/commands/web/somecommand 95 | # - touch ${DDEV_APPROOT}/somefile.${GOOS}.${DDEV_WEBSERVER} 96 | # - perl -pi -e 's/oldstring/newstring/g' ${DDEV_APPROOT}/.ddev/docker-compose.addon-template.yaml 97 | 98 | # Shell actions that can be done during removal of the add-on. 99 | # Files listed in project_files section will be automatically removed here if they contain #ddev-generated line. 100 | # removal_actions are executed in the context of the target project's .ddev directory. 101 | removal_actions: 102 | # - rm ~/.ddev/commands/web/somecommand 103 | # - | 104 | # if [ -f ${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml ]; then 105 | # if grep -q '#ddev-generated' ${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml; then 106 | # rm -f ${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml 107 | # else 108 | # echo "Unwilling to remove '${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml' because it does not have #ddev-generated in it; you can manually delete it if it is safe to delete." 109 | # fi 110 | # fi 111 | 112 | # Advanced usage - YAML files can be read in and then used as go template actions 113 | # in pre_install_actions and post_install_actions 114 | # See example in 115 | # https://github.com/ddev/ddev/blob/main/cmd/ddev/cmd/testdata/TestCmdAddonComplex/recipe/install.yaml 116 | yaml_read_files: 117 | # someyaml: someyaml.yaml 118 | # otheryaml: someotheryaml.yaml 119 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![add-on registry](https://img.shields.io/badge/DDEV-Add--on_Registry-blue)](https://addons.ddev.com) 2 | [![tests](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml?query=branch%3Amain) 3 | [![last commit](https://img.shields.io/github/last-commit/ddev/ddev-addon-template)](https://github.com/ddev/ddev-addon-template/commits) 4 | [![release](https://img.shields.io/github/v/release/ddev/ddev-addon-template)](https://github.com/ddev/ddev-addon-template/releases/latest) 5 | 6 | # DDEV Add-on Template 7 | 8 | * [What is DDEV Add-on Template?](#what-is-ddev-add-on-template) 9 | * [Update Checker](#update-checker) 10 | * [TL;DR](#tldr) 11 | * [Components of the repository](#components-of-the-repository) 12 | * [Getting started](#getting-started) 13 | * [How to debug in Github Actions](#how-to-debug-in-github-actions) 14 | * [Resources](#resources) 15 | * [Credits](#credits) 16 | 17 | ## What is DDEV Add-on Template? 18 | 19 | This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services. 20 | 21 | In DDEV, add-ons can be installed from the command line using the `ddev add-on get` command, for example, `ddev add-on get ddev/ddev-redis` or `ddev add-on get ddev/ddev-solr`. 22 | 23 | This repository is a quick way to get started. You can create a new repo from this one by clicking Use this template ⌄ button in the top right corner of the page. 24 | 25 | ![template button](images/template-button.png) 26 | 27 | ## Update Checker 28 | 29 | Run the update checker script periodically in your add-on to verify it is up to date: 30 | 31 | ```bash 32 | curl -fsSL https://ddev.com/s/addon-update-checker.sh | bash 33 | ``` 34 | 35 | ## TL;DR 36 | 37 | 1. Click the green Use this template ⌄ button (top right) > `Create a new repository`. 38 | 2. Name your repository using the `ddev-` prefix (e.g. `ddev-foobar`). 39 | 3. Add a meaningful description with relevant keywords for discoverability. 40 | 4. Click Create repository and wait for the automated "First time setup" commit. 41 | 42 | > [!NOTE] 43 | > Automated updates to the `README.md` happen in a minute or so after creation. 44 | 45 | 5. Clone your repository locally (use the <> Code ⌄ button for the URL). 46 | 6. Prepare your add-on files and tests, see [Getting started](#getting-started) for details. 47 | 7. Create a new PR for review and discussion (avoid committing directly to `main`, as that bypasses the collaborative process). 48 | 8. Merge or squash your PR into `main` (squash is preferred for a cleaner commit history). 49 | 9. Create a new [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). 50 | 10. When ready to share, make your add-on discoverable by adding the `ddev-get` [topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics). 51 | 11. Check out the [DDEV Add-on Maintenance Guide](https://ddev.com/blog/ddev-add-on-maintenance-guide/). 52 | 53 | ## Components of the repository 54 | 55 | * The fundamental contents of the add-on service or other component. For example, in this template there is a [docker-compose.addon-template.yaml](docker-compose.addon-template.yaml) file. 56 | * An [install.yaml](install.yaml) file that describes how to install the service or other component. 57 | * A test suite in [test.bats](tests/test.bats) that makes sure the service continues to work as expected. 58 | * [Github actions setup](.github/workflows/tests.yml) so that the tests run automatically when you push to the repository. 59 | 60 | ## Getting started 61 | 62 | 1. Choose a good descriptive name for your add-on. It should probably start with "ddev-" and include the basic service or functionality. If it's particular to a specific CMS, perhaps `ddev--servicename`. 63 | 2. Create the new template repository by using the template button. 64 | 3. Add the files that need to be added to a DDEV project to the repository. If your add-on does not add a new service, remove `docker-compose..yaml` file. 65 | 4. Update the `install.yaml` to give the necessary instructions for installing the add-on: 66 | 67 | * The fundamental line is the `project_files` directive, a list of files to be copied from this repo into the project `.ddev` directory. 68 | * You can optionally add files to the `global_files` directive as well, which will cause files to be placed in the global `~/.ddev` directory. 69 | * Make sure to have the `ddev_version_constraint` directive, to keep the add-on users up to date. 70 | * Finally, `pre_install_commands` and `post_install_commands` are supported. These can use the host-side environment variables documented [in DDEV docs](https://ddev.readthedocs.io/en/stable/users/extend/custom-commands/#environment-variables-provided). 71 | 72 | 5. Update `tests/test.bats` to provide a reasonable test for your repository: 73 | 74 | * In most cases, you only need to modify the `health_checks()` function and update the `GITHUB_REPO` variable to match your repository. 75 | * Tests will run automatically on every push to the repository, and periodically each night. 76 | * Please make sure to address test failures when they happen. Others will be depending on you. 77 | * Bats is a testing framework that just uses Bash. To run a Bats test locally, you have to install [bats-core](https://bats-core.readthedocs.io/en/stable/installation.html) and its [libraries](https://github.com/ztombol/bats-docs) first. 78 | * Then you download your add-on, and finally run `bats ./tests/test.bats` within the root of the uncompressed directory. 79 | * To learn more about Bats see the [documentation](https://bats-core.readthedocs.io/en/stable/). 80 | * For complex test scenarios, you can use `tests/testdata/` directory to store test fixtures. See examples in: 81 | * [ddev-cypress](https://github.com/ddev/ddev-cypress/tree/main/tests) 82 | * [ddev-rabbitmq](https://github.com/ddev/ddev-rabbitmq/tree/main/tests) 83 | * [ddev-typo3-solr](https://github.com/ddev/ddev-typo3-solr/tree/main/tests) 84 | * [ddev-upsun](https://github.com/ddev/ddev-upsun/tree/main/tests) 85 | 86 | 6. When everything is working, including the tests, you can push the repository to GitHub. 87 | 7. Create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) on GitHub. 88 | 8. Test manually with `ddev add-on get `. 89 | 9. You can test PRs with `ddev add-on get https://github.com///tarball/` or `https://github.com///tarball/refs/pull//head`. 90 | 10. You can test add-ons locally without GitHub by downloading them, making changes and running `ddev add-on get /path/to/add-on-directory`. 91 | 11. Update the [`README.md`](./README_ADDON.md) to describe the add-on, how to use it, and how to contribute. If there are any manual actions that have to be taken, please explain them. If it requires special configuration of the using project, please explain how to do those. Examples in [ddev/ddev-solr](https://github.com/ddev/ddev-solr), [ddev/ddev-memcached](https://github.com/ddev/ddev-memcached), and (advanced) [ddev-platformsh](https://github.com/ddev/ddev-platformsh). 92 | 12. Add a clear short description to your repo, and add the `ddev-get` [topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics). It will immediately be added to the list provided by `ddev add-on list --all` and appear in the [DDEV Add-on Registry](https://addons.ddev.com/) within about 24 hours. 93 | 13. Once it matures and you want it to become an officially maintained add-on (i.e., supported by the DDEV team), open an issue in the [DDEV issue queue](https://github.com/ddev/ddev/issues). 94 | 95 | ## How to debug in GitHub Actions 96 | 97 | See [full instructions](./README_DEBUG.md). 98 | 99 | ## Resources 100 | 101 | * [DDEV Add-ons: Creating, maintaining, testing](https://www.youtube.com/watch?v=TmXqQe48iqE) (part of the [DDEV Contributor Live Training](https://ddev.com/blog/contributor-training)) 102 | * [Advanced Add-On Techniques](https://ddev.com/blog/advanced-add-on-contributor-training/) 103 | * [DDEV Add-on Maintenance Guide](https://ddev.com/blog/ddev-add-on-maintenance-guide/) 104 | * [DDEV Documentation for Add-ons](https://ddev.readthedocs.io/en/stable/users/extend/additional-services/) 105 | * [DDEV Add-on Registry](https://addons.ddev.com/) 106 | 107 | ## Credits 108 | 109 | **Contributed and maintained by @CONTRIBUTOR** 110 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------