generated from ddev/ddev-addon-template
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rebase to single commit, add-on and tests working
- Loading branch information
Showing
15 changed files
with
910 additions
and
217 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,93 +1,20 @@ | ||
| [](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml)  | ||
| [](https://github.com/rfay/ddev-ibexa-cloud/actions/workflows/tests.yml)  | ||
|
|
||
| # ddev-addon-template <!-- omit in toc --> | ||
| The [Ibexa Cloud](https://www.ibexa.co/products/ibexa-cloud) has its own CLI, instead of using the `platform` CLI. | ||
|
|
||
| * [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) | ||
| This add-on provides integration for Ibexa Cloud. | ||
|
|
||
| ## What is ddev-addon-template? | ||
| 1. Configure your Ibexa project for DDEV if you haven't already, see [DDEV Ibexa Quickstart](https://ddev.readthedocs.io/en/stable/users/quickstart/#ibexa-dxp) | ||
| 2. `ddev get rfay/ddev-ibexa-cloud` (# or in DDEV v1.23.5+ `ddev add-on get rfay/ddev-ibexa-cloud`) | ||
| 3. Configure your IBEXA_CLI_TOKEN globally, `ddev config global --web-environment-add=IBEXA_CLI_TOKEN=nf4amudfn23biyourtoken` | ||
| 4. Configure your IBEXA_PROJECT, IBEXA_ENVIRONMENT, and IBEXA_APP environment variables, for example `ddev config --web-environment-add=IBEXA_PROJECT=nf4amudfn23biyourproject,IBEXA_ENVIRONMENT=main,IBEXA_APP=app` | ||
| 5. `ddev restart` | ||
| 6. `ddev pull ibexa-cloud` | ||
|
|
||
| This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services. | ||
| ## Running Automated Tests Locally | ||
|
|
||
| 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`. | ||
| * `IBEXA_CLI_TOKEN`, `IBEXA_PROJECT` and `IBEXA_ENVIRONMENT` should exist in the environment | ||
| * `brew tap kaos/shell && brew install bats-assert bats-file` | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| ## 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-<CMS>-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/stable/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 <owner/repo>`. | ||
| 10. You can test PRs with `ddev get https://github.com/<user>/<repo>/tarball/<branch>` | ||
| 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.youtube.com/watch?v=TmXqQe48iqE) (part of the [DDEV Contributor Live Training](https://ddev.com/blog/contributor-training)). | ||
|
|
||
| Note that more advanced techniques are discussed in [Advanced Add-On Techniques](https://ddev.com/blog/advanced-add-on-contributor-training/) and [DDEV docs](https://ddev.readthedocs.io/en/stable/users/extend/additional-services/). | ||
|
|
||
| ## 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/<user>/<repo>/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. | ||
|
|
||
|  | ||
|
|
||
| 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 <path-to-private-SSH-key> PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io | ||
| 108 SSH: ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io | ||
| 109 or: ssh -i <path-to-private-SSH-key> PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io | ||
| ``` | ||
|
|
||
| 9. Copy and execute the first option `ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io` in the terminal and continue by pressing either <kbd>q</kbd> or <kbd>Ctrl</kbd> + <kbd>c</kbd>. | ||
|
|
||
| 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`** | ||
| **Contributed and maintained by @rfay** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| #!/bin/bash | ||
|
|
||
| #ddev-generated | ||
| ## Description: Run ibexa_cloud CLI inside the web container | ||
| ## Usage: ibexa_cloud [flags] [args] | ||
| ## Example: "ibexa_cloud user:list" or "platform ssh" or "platform service:list" | ||
| ## ExecRaw: true | ||
|
|
||
| ibexa_cloud "$@" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| #ddev-generated | ||
| web_environment: | ||
| - PLATFORMSH_CLI_HOME=/usr/local/bin |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,112 +1,18 @@ | ||
| # 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 | ||
|
|
||
| name: addon-template | ||
|
|
||
| # pre_install_actions - list of actions to run before installing the addon. | ||
| # Examples would be removing an extraneous docker volume, | ||
| # or doing a sanity check for requirements. | ||
| # DDEV environment variables can be interpolated into these actions | ||
| # pre_install_actions are executed in the context of the target project's root directory. | ||
| name: ibexa-cloud | ||
| pre_install_actions: | ||
| # - | | ||
| # #ddev-description:Check architecture type for incompatible arm64 type | ||
| # if [ "$(uname -m)" = "arm64" -o "$(uname -m)" = "aarch64" ]; then | ||
| # echo "This package does not work on arm64 (Apple Silicon) machines"; | ||
| # exit 1; | ||
| # fi | ||
|
|
||
| # - "docker volume rm ddev-${DDEV_PROJECT}_solr 2>/dev/null || true" | ||
|
|
||
| # You can also check for client DDEV version with ddev_version_constraint (see below). | ||
| # - | | ||
| # #ddev-description:Checking DDEV version | ||
| # if ! ( ddev debug capabilities 2>/dev/null | grep corepack >/dev/null 2>&1 ) ; then | ||
| # echo "This add-on requires DDEV v1.23+ or higher, please upgrade." && exit 2 | ||
| # fi | ||
|
|
||
| # - 'echo "what is your platform.sh token" && read x' | ||
|
|
||
| # This item shows templating using DDEV environment variables. | ||
| # - | | ||
| # #ddev-description:Touch a file to create it | ||
| # touch ${DDEV_APPROOT}/.ddev/somefile.${DDEV_PROJECT_TYPE}.${DDEV_DOCROOT}.txt | ||
|
|
||
| # This item shows complex go templating possibilities based on yaml_read_files | ||
| # - | | ||
| # #ddev-description:Create a config.platformsh.yaml | ||
| # cat <<EOF >${DDEV_APPROOT}/.ddev/config.platformsh.yaml | ||
| # php_version: {{ trimPrefix "php:" .platformapp.type }} | ||
| # database: | ||
| # type: {{ regexReplaceAll ":.*$" .services.db.type "" }} | ||
| # version: {{ regexReplaceAll "^.*:" .services.db.type "" }} | ||
|
|
||
| # docroot: {{ dig "web" "locations" "/" "root" "notfound" .platformapp }} | ||
| # {{- if eq .platformapp.build.flavor "composer" }} | ||
| # hooks: | ||
| # post-start: | ||
| # - composer: install | ||
| # {{- if .platformapp.hooks.deploy }} | ||
| # - exec: "{{ trimAll "\n" .platformapp.hooks.deploy | splitList "\n" | join ` && ` }}" | ||
| # {{- end }} | ||
| # {{- end }} | ||
|
|
||
| # EOF | ||
|
|
||
| # list of files and directories listed that are copied into project .ddev directory | ||
| # Each file should contain #ddev-generated so it can be replaced by a later `ddev get` | ||
| # if it hasn't been modified by the user. | ||
| # DDEV environment variables can be interpolated into these filenames | ||
| # If you use directories, they must be directories that are managed | ||
| # by this add-on, or removal could remove things that are not owned by it | ||
| project_files: | ||
| - docker-compose.addon-template.yaml | ||
| # - some-directory/file1.txt | ||
| # - some-directory/file2.txt | ||
| # - extra_files_dir_created_by_this_template/ | ||
| # - somefile.sh | ||
| - commands/web/ibexa_cloud | ||
| - config.ibexa-cloud.yaml | ||
| - providers/ibexa-cloud.yaml | ||
| - web-build/Dockerfile.ibexa-cloud | ||
|
|
||
| # List of files and directories that are copied into the global .ddev directory | ||
| # DDEV environment variables can be interpolated into these filenames | ||
| global_files: | ||
| # - commands/web/add-on-command | ||
| # - homeadditions/some-file.txt | ||
|
|
||
| # Version constraint for DDEV that will be validated against the running DDEV executable | ||
| # and prevent add-on from being installed if it doesn't validate. | ||
| # See https://github.com/Masterminds/semver#checking-version-constraints for constraint rules. | ||
| # Available with DDEV v1.23.4+, and works only for DDEV v1.23.4+ binaries | ||
| # example: ddev_version_constraint: '>= v1.23.4' | ||
| ddev_version_constraint: '' | ||
|
|
||
| # List of add-on names that this add-on depends on | ||
| dependencies: | ||
| # - redis | ||
|
|
||
| # DDEV environment variables can be interpolated into these actions. | ||
| # post_install_actions are executed in the context of the target project's .ddev directory. | ||
| post_install_actions: | ||
| # - chmod +x ~/.ddev/commands/web/somecommand | ||
| # - touch ${DDEV_APPROOT}/somefile.${GOOS}.${DDEV_WEBSERVER} | ||
| # - perl -pi -e 's/oldstring/newstring/g' ${DDEV_APPROOT}/.ddev/docker-compose.addon-template.yaml | ||
|
|
||
| # Shell actions that can be done during removal of the add-on. | ||
| # Files listed in project_files section will be automatically removed here if they contain #ddev-generated line. | ||
| # removal_actions are executed in the context of the target project's .ddev directory. | ||
| removal_actions: | ||
| # - rm ~/.ddev/commands/web/somecommand | ||
| # - | | ||
| # if [ -f ${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml ]; then | ||
| # if grep -q '#ddev-generated' ${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml; then | ||
| # rm -f ${DDEV_APPROOT}/.ddev/docker-compose.addon-template_extras.yaml | ||
| # else | ||
| # 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." | ||
| # fi | ||
| # fi | ||
|
|
||
| # Advanced usage - YAML files can be read in and then used as go template actions | ||
| # in pre_install_actions and post_install_actions | ||
| # See example in | ||
| # https://github.com/ddev/ddev/blob/master/cmd/ddev/cmd/testdata/TestCmdAddonComplex/recipe/install.yaml | ||
| yaml_read_files: | ||
| # someyaml: someyaml.yaml | ||
| # otheryaml: someotheryaml.yaml | ||
|
|
Oops, something went wrong.