config_pr
Config Pull Request
The Config Pull Request module allows site builders to create pull requests for configurations changes done via Drupal UI.
The pull requests that can be reviewed on the repository and merged.
This module is helpful for site builders that do not know how to use Git in the command line and for stakeholders that want the changes in the UI to be comitted in the codebase. It helps to prevent configurations changed in the UI from being reverted after a deployment when configuration is automatically imported.
How it works
After the Admin is done with the configuration changes, they will visit the Configuration Management page, click on the Pull Request tab, select the configs that they want to keep in the Pull Request.
They will confirm the repo url and give it a title and description, then press the submit button.
The module will check user authentication on the repo and create the pull request.
It can also notify Devs about the Pull Request created.
The code reviewer will review, comment, accept or reject the Pull Request.
Note: You do not need to have a local repository on Live/Staging environment. This module pushes directly to the repository using APIs
Case study
There are some changes needed on the configuration of Google Analytics.
- The Audience Dev team made some tweaks on the Staging environment.
- They go to the Config Pull Request page, select the configurations they want to keep and issue a pull request.
- Then they create a ticket and assign to the pull request.
- The developers will review it, test and merge
- The ticket is deployed
- Audience Dev team will get exactly what they asked for
Without this module, the workflow could be:
- Audience Dev requests changes to the Google Analytics module
- Product manager creates a ticket with the requirements (At this point we can have a communication issue and not all requirements will end up in the ticket)
- A developer picks up the ticket and implements the requirements (At this point the Developer might misunderstand the requirements and implement something else instead)
- A tester picks up the ticket (Being human, the tester can also fail to spot something the Developer missed)
- The ticket goes live.
- Audience Dev finds a problem.
- Back to #1
Pros
- Speeds up the process of exporting last minute/urgent changes
- Allows stakeholders to tweak the configurations quickly and keep the changes
- Helps site builders to export config without having to use the command line
Supported repositories
- Github
- GitLab
- BitBucket (in Development)
Similar modules
Config Patch
Provides a framework for providing patch files for config (the differences between active configuration and sync configuration)
Installation
Install the Config Pull request module.
If you are usig Github or Gitlab, you need to install the sub-module and the respective libraries using Composer.
Each module and sub-module contains a Readme that lists the Composer dependencies.
Screenshots