Drupal extension template for development and testing in CI of your choice with mirroring to Drupal.org

Perform extension development in GitHub with testing in CI, and push code committed only to main branches (1.x, 2.x etc.) to drupal.org.

• Turnkey CI configuration with artifacts and test results support.
  • PHP version matrix for 8.2 and 8.1.
  • Drupal version matrix: stable, next and last EOL version.
  • CI providers:
    • CircleCI
    • GitHub Actions (coming soon)
• Tools:
  • Develop locally using PHP running on your host using identical .devtools scripts as in CI.
    • Uses drupal-composer/drupal-project to create drupal site structure. Providing a custom fork of drupal-project is also supported.
    • Additional development dependenices provided in composer.dev.json. These are merged during the codebase build.
    • The extension can installed as a module or a theme: modify type property set in the info.yml file.
    • Additional dependencies can be added for integration testing between extensions: add dependency into suggest section of composer.json.
      
  • Codings standards checking:
    • PHP code standards checking against Drupal and DrupalPractice standards.
    • PHP code static analysis with PHPStan (including PHPStan Drupal).
    • PHP deprecated code analysis with Drupal Rector.
    • Twig code analysis with TwigCS.
  • Drupal's Simpletest testing support - runs tests in the same way as drupal.org's Drupal CI bot (core/scripts/run-tests.sh).
  • Renovate configuration to keep your repository dependencies up-to-date.
• Deployment:
  • Mirroring of the repo to drupal.org (or any other git repo) on release.
  • Deploy to a destination branch different from the source branch.
  • Tags mirroring.
• This template is tested in the same way as a project using it.

1. Create your extension's repository on GitHub.
2. Download this extension's code by pressing 'Clone or download' button in GitHub UI.
3. Copy the contents of the downloaded archive into your extension's repository.
4. Adjust the codebase:
   1. Replace your_extension with the machine name of your extension:
   2. Update type: theme in the info.yml file if your extension is a theme.
   3. Adjust several lines in .gitattributes.
   4. Remove .github/test-scaffold.yml file.
   5. Remove this content from README.md file.
5. Commit and push to your new GitHub repo.
6. Login to your CI and add your new GitHub repository. Your project build will start momentarily.
7. Configure deployment to drupal.org (see below).

ssh-keygen -m PEM -t rsa -b 4096 -C "[email protected]"

Below is a content of the README.md file that will be added to your project.

The content above this line should be removed.

Few lines describing your project.

• Your first feature as a list item
• Your second feature as a list item
• Your third feature as a list item

Provided that you have PHP installed locally, you can develop an extension using the provided scripts.

Run .devtools/build-codebase.sh (or ahoy build-codebase if Ahoy is installed) to start inbuilt PHP server locally and run the same commands as in CI, plus installing a site and your extension automatically.

Run tools individually (or ahoy lint to run all tools if Ahoy is installed) to lint your code according to the Drupal coding standards.

cd build

vendor/bin/phpcs
vendor/bin/phpstan
vendor/bin/rector --clear-cache --dry-run
vendor/bin/phpmd . text phpmd.xml
vendor/bin/twigcs

• PHPCS config: phpcs.xml
• PHPStan config: phpstan.neon
• PHPMD config: phpmd.xml
• Rector config: rector.php
• TwigCS config: .twig_cs.php

Run .devtools/test.sh (or ahoy test if Ahoy is installed) to run all test for your extension.

To browse the contents of created SQLite database (located at /tmp/site_[EXTENSION_NAME].sqlite), use DB Browser for SQLite.