feat: first time setup, fixes #65, fixes #40 (#75)

stasadev · web-flow · commit 5e8a91cd880f · 2025-05-07T20:20:52.000+03:00
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,15 +1,19 @@
 ## The Issue
 
-- #<issue number>
+- Fixes #REPLACE_ME_WITH_RELATED_ISSUE_NUMBER
 
 <!-- Provide a brief description of the issue. -->
 
 ## How This PR Solves The Issue
 
+<!-- Describe the key change(s) in this PR that address the issue above. -->
+
 ## Manual Testing Instructions
 
+<!-- If this PR changes logic, consider adding additional steps or context to the instructions below. -->
+
 ```bash
-ddev add-on get https://github.com/<user>/<repo>/tarball/<branch>
+ddev add-on get https://github.com/ddev/ddev-addon-template/tarball/refs/pull/REPLACE_ME_WITH_THIS_PR_NUMBER/head
 ddev restart
 ```
 
diff --git a/.github/scripts/first-time-setup.sh b/.github/scripts/first-time-setup.sh
@@ -0,0 +1,74 @@
+#!/usr/bin/env bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+GITHUB_REPOSITORY=${1?Error: Please pass repo org/name, e.g. ddev/ddev-addon-name}
+
+# Extract variables
+FULL_REPO_NAME="$GITHUB_REPOSITORY"
+REPO_NAME="${GITHUB_REPOSITORY##*/}"
+USER_NAME="${GITHUB_REPOSITORY%%/*}"
+REPLACE_UNDERSCORES=${REPO_NAME//_/-}
+NO_PREFIX_NAME="${REPLACE_UNDERSCORES#ddev-}"
+LOWERCASE_NAME="${NO_PREFIX_NAME,,}"
+ENV_VAR_NAME=$(echo "${LOWERCASE_NAME//-/_}_DOCKER_IMAGE" | tr '[:lower:]' '[:upper:]')
+PRETTY_NAME=$(echo "$LOWERCASE_NAME" | sed 's/-/ /g' | awk '{for(i=1;i<=NF;i++) $i=toupper(substr($i,1,1)) substr($i,2)} 1')
+
+update_readme() {
+    mv README_ADDON.md README.md
+
+    sed -i "s|ddev/ddev-addon-template|$FULL_REPO_NAME|g" README.md
+    sed -i "s|addon-template|$LOWERCASE_NAME|g" README.md
+    sed -i "s|Add-on Template|$PRETTY_NAME|g" README.md
+    sed -i "s|ADDON_TEMPLATE_DOCKER_IMAGE|$ENV_VAR_NAME|g" README.md
+    sed -i "s|@CONTRIBUTOR|\[@$USER_NAME\](https://github.com/$USER_NAME)|g" README.md
+}
+
+update_docker_compose() {
+    local old_file="docker-compose.addon-template.yaml"
+    local new_file="docker-compose.$LOWERCASE_NAME.yaml"
+    mv "$old_file" "$new_file"
+
+    sed -i "s|addon-template|$LOWERCASE_NAME|g" "$new_file"
+    sed -i "s|ADDON_TEMPLATE_DOCKER_IMAGE|$ENV_VAR_NAME|g" "$new_file"
+}
+
+update_tests_and_templates() {
+    sed -i "s|ddev/ddev-addon-template|$FULL_REPO_NAME|g" tests/test.bats
+    sed -i "s|ddev/ddev-addon-template|$FULL_REPO_NAME|g" .github/PULL_REQUEST_TEMPLATE.md
+}
+
+update_license() {
+    sed -i "s|Copyright \[yyyy\]|Copyright $(date +'%Y')|g" LICENSE
+}
+
+create_install_yaml() {
+    cat <<EOF > install.yaml
+name: $LOWERCASE_NAME
+
+project_files:
+  - docker-compose.$LOWERCASE_NAME.yaml
+
+ddev_version_constraint: '>= v1.24.3'
+EOF
+}
+
+cleanup_files() {
+    rm -f README_DEBUG.md
+    rm -f .github/workflows/first-time-setup.yml
+    rm -rf images
+    rm -rf .github/scripts
+}
+
+main() {
+    update_readme
+    update_docker_compose
+    update_tests_and_templates
+    update_license
+    create_install_yaml
+    cleanup_files
+}
+
+main
diff --git a/.github/workflows/first-time-setup.yml b/.github/workflows/first-time-setup.yml
@@ -0,0 +1,34 @@
+name: first-time-setup
+
+on:
+  push:
+    branches: [ main ]
+
+# Only keep latest run of this workflow and cancel any previous runs
+concurrency:
+  group: first-time-setup
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+
+jobs:
+  first-time-setup:
+    if: ${{ !github.event.repository.is_template }}
+
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Update files
+        run: ./.github/scripts/first-time-setup.sh "$GITHUB_REPOSITORY"
+
+      - name: Commit and push changes
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add .
+          git commit -m "First time setup"
+          git push
diff --git a/README.md b/README.md
@@ -3,14 +3,17 @@
 [![last commit](https://img.shields.io/github/last-commit/ddev/ddev-addon-template)](https://github.com/ddev/ddev-addon-template/commits)
 [![release](https://img.shields.io/github/v/release/ddev/ddev-addon-template)](https://github.com/ddev/ddev-addon-template/releases/latest)
 
-# DDEV add-on template <!-- omit in toc -->
+# DDEV Add-on Template <!-- omit in toc -->
 
-* [What is DDEV add-on template?](#what-is-ddev-add-on-template)
+* [What is DDEV Add-on Template?](#what-is-ddev-add-on-template)
+* [TL;DR](#tldr)
 * [Components of the repository](#components-of-the-repository)
 * [Getting started](#getting-started)
-* [How to debug in Github Actions](./README_DEBUG.md)
+* [How to debug in Github Actions](#how-to-debug-in-github-actions)
+* [Resources](#resources)
+* [Credits](#credits)
 
-## What is DDEV add-on template?
+## What is DDEV Add-on Template?
 
 This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services.
 
@@ -20,6 +23,23 @@ This repository is a quick way to get started. You can create a new repo from th
 
 ![template button](images/template-button.png)
 
+## TL;DR
+
+1. Click the green `Use this template button` (top right) > `Create a new repository`.
+2. Name your repository using the `ddev-` prefix (e.g. `ddev-foobar`).
+3. Add a meaningful description with relevant keywords for discoverability.
+4. Click `Create repository` and wait for the automated `First time setup` commit.
+
+> [!NOTE]
+> Automated updates to the `README.md` happen in a minute or so after creation.
+
+5. Clone your repository locally (use the green `<> Code` button for the URL).
+6. Prepare your add-on files and tests, see [Getting started](#getting-started) for details.
+7. Create a new PR for review and discussion (avoid committing directly to `main`, as that bypasses the collaborative process).
+8. Merge or squash your PR into `main` (squash is preferred for a cleaner commit history).
+9. Create a new [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).
+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).
+
 ## 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.
@@ -31,27 +51,35 @@ This repository is a quick way to get started. You can create a new repo from th
 
 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:
+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.<addon-name>.yaml` file.
+4. 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 will run automatically on every push to the repository, and periodically each night. Please make sure to address test failures when they happen. Others will be depending on you. 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. 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 add-on get <owner/repo>`.
-10. You can test PRs with `ddev add-on get https://github.com/<user>/<repo>/tarball/<branch>`.
-11. You can test add-ons locally without GitHub by downloading them, making changes and running `ddev add-on get /path/to/add-on-directory`.
-12. Update the `README.md` header, adding the machine name of the add-on, for example `# ddev-redis`, not `# DDEV Redis`.
-13. 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).
-14. 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 add-on list --all`.
-15. 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.
+5. Update `tests/test.bats` to provide a reasonable test for your repository. In most cases, you only need to modify the `health_checks()` function. Tests will run automatically on every push to the repository, and periodically each night. Please make sure to address test failures when they happen. Others will be depending on you. 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. 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/).
+6. When everything is working, including the tests, you can push the repository to GitHub.
+7. Create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) on GitHub.
+8. Test manually with `ddev add-on get <owner/repo>`.
+9. You can test PRs with `ddev add-on get https://github.com/<user>/<repo>/tarball/<branch>` or `https://github.com/<user>/<repo>/tarball/refs/pull/<pr-number>/head`.
+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`.
+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).
+12. Add a good 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`.
+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.
+
+## How to debug in Github Actions
+
+See [full instructions](./README_DEBUG.md).
+
+## Resources
 
-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)).
+* [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))
+* [Advanced Add-On Techniques](https://ddev.com/blog/advanced-add-on-contributor-training/)
+* [DDEV Add-on Maintenance Guide](https://ddev.com/blog/ddev-add-on-maintenance-guide/)
+* [DDEV docs](https://ddev.readthedocs.io/en/stable/users/extend/additional-services/)
+* [DDEV Add-on Registry](https://addons.ddev.com/)
 
-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/).
+## Credits
 
-**Contributed and maintained by `@CONTRIBUTOR`**
+**Contributed and maintained by @CONTRIBUTOR**
diff --git a/README_ADDON.md b/README_ADDON.md
@@ -0,0 +1,48 @@
+[![add-on registry](https://img.shields.io/badge/DDEV-Add--on_Registry-blue)](https://addons.ddev.com)
+[![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)
+[![last commit](https://img.shields.io/github/last-commit/ddev/ddev-addon-template)](https://github.com/ddev/ddev-addon-template/commits)
+[![release](https://img.shields.io/github/v/release/ddev/ddev-addon-template)](https://github.com/ddev/ddev-addon-template/releases/latest)
+
+# DDEV Add-on Template
+
+## Overview
+
+This add-on integrates Add-on Template into your [DDEV](https://ddev.com/) project.
+
+## Installation
+
+```bash
+ddev add-on get ddev/ddev-addon-template
+ddev restart
+```
+
+After installation, make sure to commit the `.ddev` directory to version control.
+
+## Usage
+
+| Command | Description |
+| ------- | ----------- |
+| `ddev describe` | View service status and used ports for Add-on Template |
+| `ddev logs -s addon-template` | Check Add-on Template logs |
+
+## Advanced Customization
+
+To change the Docker image:
+
+```bash
+ddev dotenv set .ddev/.env.addon-template --addon-template-docker-image="busybox:stable"
+ddev add-on get ddev/ddev-addon-template
+ddev restart
+```
+
+Make sure to commit the `.ddev/.env.addon-template` file to version control.
+
+All customization options (use with caution):
+
+| Variable | Flag | Default |
+| -------- | ---- | ------- |
+| `ADDON_TEMPLATE_DOCKER_IMAGE` | `--addon-template-docker-image` | `busybox:stable` |
+
+## Credits
+
+**Contributed and maintained by @CONTRIBUTOR**
diff --git a/docker-compose.addon-template.yaml b/docker-compose.addon-template.yaml
@@ -3,13 +3,13 @@
 services:
   addon-template:
     container_name: ddev-${DDEV_SITENAME}-addon-template
-    image: busybox:stable
+    image: ${ADDON_TEMPLATE_DOCKER_IMAGE:-busybox:stable}
     command: tail -f /dev/null
     restart: "no"
     # These labels ensure this service is discoverable by DDEV.
     labels:
       com.ddev.site-name: ${DDEV_SITENAME}
-      com.ddev.approot: $DDEV_APPROOT
+      com.ddev.approot: ${DDEV_APPROOT}
 
     volumes:
       - ".:/mnt/ddev_config"
