|
11 | 11 |
|
12 | 12 | This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services.
|
13 | 13 |
|
14 |
| -In DDEV addons can be installed from the command line using the `ddev get` command, for example, `ddev get ddev/ddev-addon-template` or `ddev get ddev/ddev-drupal9-solr`. |
| 14 | +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`. |
15 | 15 |
|
16 |
| -A repository like this one is the 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. |
| 16 | +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. |
17 | 17 |
|
18 | 18 | 
|
19 | 19 |
|
@@ -41,13 +41,14 @@ A repository like this one is the way to get started. You can create a new repo
|
41 | 41 | 8. Create a release on GitHub.
|
42 | 42 | 9. Test manually with `ddev get <owner/repo>`.
|
43 | 43 | 10. You can test PRs with `ddev get https://github.com/<user>/<repo>/tarball/<branch>`
|
44 |
| -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-drupal9-solr](https://github.com/ddev/ddev-drupal9-solr), [ddev/ddev-memcached](github.com/ddev/ddev-memcached), and [ddev/ddev-beanstalkd](https://github.com/ddev/ddev-beanstalkd). |
| 44 | +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](github.com/ddev/ddev-memcached), and (advanced) [ddev-platformsh](https://github.com/ddev/ddev-platformsh). |
45 | 45 | 12. Add a good short description to your repo, and add the label "ddev-get". It will immediately be added to the list provided by `ddev get --list --all`.
|
46 | 46 | 13. 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.
|
47 | 47 |
|
48 | 48 | 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).
|
49 | 49 |
|
50 |
| -## How to debug in Github Actions |
| 50 | +## How to debug tests (Github Actions) |
| 51 | + |
51 | 52 | 1. You need a SSH-key registered with Github. You either pick the key you already authenticate 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`.
|
52 | 53 |
|
53 | 54 | 2. Add the following snippet to `~/.ssh/config`
|
@@ -86,6 +87,5 @@ Host *.tmate.io
|
86 | 87 |
|
87 | 88 | For a more detailed documentation about `tmate` see [Debug your GitHubActions by using tmate](https://mxschmitt.github.io/action-tmate/)
|
88 | 89 |
|
89 |
| -**Contributed and maintained by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR) based on the original [ddev-contrib recipe](https://github.com/ddev/ddev-contrib/tree/master/docker-compose-services/RECIPE) by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR)** |
90 | 90 |
|
91 |
| -**Originally Contributed by [somebody](https://github.com/somebody) in <https://github.com/ddev/ddev-contrib/> |
| 91 | +**Contributed and maintained by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR)** |
0 commit comments