The module allows to safely deploy configuration changes from preview environments to production. It works with the Drupal configuration checkpoint API to produce a diff / patch of changes and applies this to production, without the need of console access.
Features
- Configuration Tracking: Tracks changes on production and verifies base-configuration checkpoint is recent before deployment
- Rebase Workflow: Fully integrated rebase workflow to update preview environment configuration with latest production changes
- Authentication: OAuth 2.0 authorization code flow + hash-based request integrity verification
- Web UI & CLI: Provides both Drupal UI and drush commands for seamless deployment
- Config Ignore Support: Optional integration to exclude environment-specific configs from deployment
Usage
Please refer to the README for detailed instructions.
Dependencies
- Key - For storing OAuth client secret
- Simple OAuth - For authorizing configuration deployments
Recommended modules/libraries
- Config Checkpoint UI - Offers UI for reverting to generated checkpoints.
- Config Ignore - Configure config to ignore during deployment
Similar projects
- Config Patch - Provides config changes as patches, which shall be applied to a deploy config sync folder.
AI usage disclosure
- AI has been used in crafting the majority of the code of the module, including the implementation of the main features, documentation, and examples.
- The module has been fully reviewed and tested by the contributor.
Status
under heavy development & testing
Short name
config_preview_deploy
Supporting organizations
Development, Maintenance