Continuous integration¶
This extension wants to make it easy to roll out CI process for your Drupal application.
Supported platforms and workflows¶
- GitHub Actions
- Automatic upgrades with a pull request
- Composer diff
GitHub Actions¶
Automatic upgrades with a pull request¶
This workflow does the following:
- Sets up all sites using each site's configured setup strategy.
- Runs the configured Drupal upgrade strategy.
- For each site, runs database updates and exports configuration (if applicable).
- Creates a pull request with the changes.
Pre-requisites¶
DDEV¶
The OOTB workflow file assumes the project uses DDEV, and it executes commands via DDEV in the workflow.
Create or reuse a custom GitHub application¶
You will need to have a custom GitHub application configured with the following permissions:
- Read access to members and data
- Read and write access to code and pull requests
Ensure to enable the application for the repository for your project.
We need to create two repository secrets: DP_PR_APP_ID and DP_PR_APP_KEY.
The DP_PR_APP_ID is the ID of the GitHub application. The DP_PR_APP_KEY
is a private key associated with the GitHub app.
SSH key¶
Finally, you need to add a repository secret, SSH_KEY, that
contains a private SSH key. You should only need this if any of your site setup
strategies depend on having this SSH key available.
Composer diff¶
This workflow runs on every pull request that contains changes to
composer.lock. It will post, as a sticky comment on the pull request,
a table with a row for each package changed with the following fields:
- Package name
- Change type
- Previous version
- New version
- Link to package changes code diff (Drupal packages are supported!)
It relies on the Composer Diff plugin to generate a
version diff of the changes made to the composer.lock file.
Example Composer diff table of changes
Initializing workflows¶
Currently, you can initialize the workflows by running
polymer drupal:workflow:generate github. This will place the supported
workflows in .github/workflows/.