From 31511782713b387b30b69127ebe94aa658153954 Mon Sep 17 00:00:00 2001 From: Christian Fritsch Date: Fri, 28 Jun 2024 11:43:38 +0200 Subject: [PATCH] Add annotations --- README.md | 94 +----------------------------- commands/host/install-playwright | 4 ++ commands/host/playwright | 4 ++ commands/web/dump-test-database | 6 +- commands/web/phpstan | 4 -- docker-compose.addon-template.yaml | 17 ------ install.yaml | 1 - 7 files changed, 14 insertions(+), 116 deletions(-) delete mode 100755 commands/web/phpstan delete mode 100644 docker-compose.addon-template.yaml diff --git a/README.md b/README.md index 2880389..bf2f019 100644 --- a/README.md +++ b/README.md @@ -1,93 +1 @@ -[![tests](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml/badge.svg)](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg) - -# ddev-addon-template - -* [What is ddev-addon-template?](#what-is-ddev-addon-template) -* [Components of the repository](#components-of-the-repository) -* [Getting started](#getting-started) -* [How to debug in Github Actions](#how-to-debug-tests-github-actions) - -## What is ddev-addon-template? - -This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services. - -In DDEV addons can be installed from the command line using the `ddev get` command, for example, `ddev get ddev/ddev-redis` or `ddev get ddev/ddev-solr`. - -This repository is a quick way to get started. You can create a new repo from this one by clicking the template button in the top right corner of the page. - -![template button](images/template-button.png) - -## Components of the repository - -* 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. -* An [install.yaml](install.yaml) file that describes how to install the service or other component. -* A test suite in [test.bats](tests/test.bats) that makes sure the service continues to work as expected. -* [Github actions setup](.github/workflows/tests.yml) so that the tests run automatically when you push to the repository. - -## Getting started - -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`. -2. Create the new template repository by using the template button. -3. Globally replace "addon-template" with the name of your add-on. -4. Add the files that need to be added to a DDEV project to the repository. For example, you might replace `docker-compose.addon-template.yaml` with the `docker-compose.*.yaml` for your recipe. -5. Update the `install.yaml` to give the necessary instructions for installing the add-on: - - * The fundamental line is the `project_files` directive, a list of files to be copied from this repo into the project `.ddev` directory. - * You can optionally add files to the `global_files` directive as well, which will cause files to be placed in the global `.ddev` directory, `~/.ddev`. - * 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/latest/users/extend/custom-commands/#environment-variables-provided). - -6. Update `tests/test.bats` to provide a reasonable test for your repository. Tests are triggered either by manually executing `bats ./tests/test.bats`, automatically on every push to the repository, or periodically each night. Please make sure to attend to test failures when they happen. Others will be depending on you. Bats is a simple 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) first. Then you download your add-on, and finally run `bats ./tests/test.bats` within the root of the uncompressed directory. To learn more about Bats see the [documentation](https://bats-core.readthedocs.io/en/stable/). -7. When everything is working, including the tests, you can push the repository to GitHub. -8. Create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) on GitHub. -9. Test manually with `ddev get `. -10. You can test PRs with `ddev get https://github.com///tarball/` -11. Update the `README.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). -12. Update the `README.md` header in Title Case format, for example, use `# DDEV Redis`, not `# ddev-redis`. -13. Add a good short description to your repo, and add the [topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) "ddev-get". It will immediately be added to the list provided by `ddev get --list --all`. -14. When it has matured you will hopefully want to have it become an "official" maintained add-on. Open an issue in the [DDEV queue](https://github.com/ddev/ddev/issues) for that. - -Add-ons were covered in [DDEV Add-ons: Creating, maintaining, testing](https://www.dropbox.com/scl/fi/bnvlv7zswxwm8ix1s5u4t/2023-11-07_DDEV_Add-ons.mp4?rlkey=5cma8s11pscxq0skawsoqrscp&dl=0) (part of the [DDEV Contributor Live Training](https://ddev.com/blog/contributor-training)). - -Note that more advanced techniques are discussed in [DDEV docs](https://ddev.readthedocs.io/en/latest/users/extend/additional-services/#additional-service-configurations-and-add-ons-for-ddev). - -## How to debug tests (Github Actions) - -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`. - -2. Add the following snippet to `~/.ssh/config`: - -``` -Host *.tmate.io - User git - AddKeysToAgent yes - UseKeychain yes - PreferredAuthentications publickey - IdentitiesOnly yes - IdentityFile ~/.ssh/tmate_ed25519 -``` -3. Go to `https://github.com///actions/workflows/tests.yml`. - -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. - -![tmate](images/gh-tmate.jpg) - -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. - -7. Pick one of the jobs in progress in the sidebar. - -8. Wait until the current task list reaches the `tmate debugging session` section and the output shows something like: - -``` -106 SSH: ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io -107 or: ssh -i PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io -108 SSH: ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io -109 or: ssh -i PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io -``` - -9. Copy and execute the first option `ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io` in the terminal and continue by pressing either q or Ctrl + c. - -10. Start the Bats test with `bats ./tests/test.bats`. - -For a more detailed documentation about `tmate` see [Debug your GitHub Actions by using tmate](https://mxschmitt.github.io/action-tmate/). - -**Contributed and maintained by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR)** +# DDEV - DPP Add-on \ No newline at end of file diff --git a/commands/host/install-playwright b/commands/host/install-playwright index 396bb53..2eb5b5a 100755 --- a/commands/host/install-playwright +++ b/commands/host/install-playwright @@ -1,6 +1,10 @@ #!/bin/sh #ddev-generated +## Description: Install Playwright in the project +## Usage: install-playwright +## Example: "ddev install-playwright" + mkdir -p "${DDEV_APPROOT}/tests/Playwright" cd "${DDEV_APPROOT}/tests/Playwright" || exit npm init playwright@latest diff --git a/commands/host/playwright b/commands/host/playwright index 36edf73..7992896 100755 --- a/commands/host/playwright +++ b/commands/host/playwright @@ -1,6 +1,10 @@ #!/bin/sh #ddev-generated +## Description: Run Playwright commands +## Usage: playwright +## Example: "ddev playwright" + cd "${DDEV_APPROOT}/tests/Playwright" || exit 1 export PLAYWRIGHT_BASE_URL=$DDEV_PRIMARY_URL if [ -f yarn.lock ]; then diff --git a/commands/web/dump-test-database b/commands/web/dump-test-database index 725d2de..90be8f5 100755 --- a/commands/web/dump-test-database +++ b/commands/web/dump-test-database @@ -1,6 +1,10 @@ #!/bin/sh #ddev-generated +## Description: Dump the database as PHP file into the docroot. +## Usage: dump-test-database +## Example: ddev dump-test-database + cd "${DDEV_COMPOSER_ROOT}"/"${DDEV_DOCROOT}" || exit # shellcheck disable=SC2154 -php core/scripts/db-tools.php dump-database-d8-mysql > "${thunderDumpFile}" \ No newline at end of file +php core/scripts/db-tools.php dump-database-d8-mysql > "${thunderDumpFile}" diff --git a/commands/web/phpstan b/commands/web/phpstan deleted file mode 100755 index 7d2d2ac..0000000 --- a/commands/web/phpstan +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh -#ddev-generated - -composer exec phpstan analyze -- "$@" diff --git a/docker-compose.addon-template.yaml b/docker-compose.addon-template.yaml deleted file mode 100644 index 7c9844e..0000000 --- a/docker-compose.addon-template.yaml +++ /dev/null @@ -1,17 +0,0 @@ -#ddev-generated -# Simple template to demonstrate addon-template -services: - addon-template: - container_name: ddev-${DDEV_SITENAME}-addon-template - image: busybox:stable - command: tail -f /dev/null - networks: [default, ddev_default] - restart: "no" - # These labels ensure this service is discoverable by ddev. - labels: - com.ddev.site-name: ${DDEV_SITENAME} - com.ddev.approot: $DDEV_APPROOT - - volumes: - - ".:/mnt/ddev_config" - - "ddev-global-cache:/mnt/ddev-global-cache" diff --git a/install.yaml b/install.yaml index 3b92db9..bd835d1 100644 --- a/install.yaml +++ b/install.yaml @@ -63,7 +63,6 @@ project_files: - config.dpp.yml - commands/host/install-playwright - commands/host/playwright - - commands/web/phpstan - commands/web/dump-test-database - dpp/add-base-url.js # - docker-compose.addon-template.yaml