Starter Template

This repository is a template for creating a Drupal Forge app from a Composer project. It performs a clean Drupal install with a default admin password of admin. If you want to turn an existing Drupal Forge app into a template, you do not need this. The Composer project to create is specified by the PROJECT environment variable. If PROJECT is not defined, it defaults to drupal/recommended-project.

• You can set a different default value for PROJECT in .devpanel/composer_setup.sh.
• To skip creating a project with Composer, add your own composer.json to the repository root.

How to run this template

• This repository is optimized for fast deployment with DevPanel. DevPanel deployment files are in the .devpanel directory. You can add the .devpanel directory from this repository to an existing repository.
• You can run this repository with any tool that supports dev containers.
• This repository is also configured to run with DDEV.

Publishing a quick start image

For faster deployment, go to the Actions tab in GitHub after you create a new repository from this template and add a workflow that pre-deploys your template in a Docker image, reducing the time needed to launch a site.

• If your repository is in the Drupal Forge GitHub organization, the Drupal Forge Docker build and push template can set up the workflow for you. The workflow will generate a new Docker image whenever a commit is pushed to the main or test/* branches. Your images will be in the Drupal Forge Docker Hub account.

• Otherwise, set up your own workflow with the Drupal Forge Docker Publish action. It includes a reusable workflow you can call from your workflow. This is how the reusable workflow is used in the Drupal Forge Docker build and push template:

  name: Docker build and push template
  on:
    push:
      branches:
        - main
        - test/*
    workflow_dispatch:
  jobs:
    build-application:
      uses: drupalforge/docker_publish_action/.github/workflows/docker-publish.yml@main
      with:
        dockerhub_username: ${{ vars.DOCKERHUB_USERNAME }}
      secrets:
        dockerhub_token: ${{ secrets.DOCKERHUB_TOKEN }}
        dp_ai_virtual_key: ${{ secrets.DP_AI_VIRTUAL_KEY }}