https://github.com/workingconcept/trigger-craft-plugin
Kick off static deployments from Craft CMS only when you need them.
https://github.com/workingconcept/trigger-craft-plugin
craft3 craftcms deployments utility
Last synced: 5 months ago
JSON representation
Kick off static deployments from Craft CMS only when you need them.
- Host: GitHub
- URL: https://github.com/workingconcept/trigger-craft-plugin
- Owner: workingconcept
- License: mit
- Created: 2019-10-18T01:00:57.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2022-08-31T21:37:03.000Z (almost 4 years ago)
- Last Synced: 2025-10-23T16:46:44.973Z (8 months ago)
- Topics: craft3, craftcms, deployments, utility
- Language: PHP
- Homepage:
- Size: 248 KB
- Stars: 13
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license.md
Awesome Lists containing this project
README
Trigger Craft CMS 3 Plugin
Kick off static deployments only when you need to.
---
**As of v2.3.1, the first-party [Webhooks plugin](https://github.com/craftcms/webhooks) supports debouncing requests. You may want to give that a look first!**
## Overview
A simple plugin to kick off builds asynchronously, ideal for something like a headless [GatsbyJS](https://www.gatsbyjs.org/) or [Gridsome](https://gridsome.org/) frontend deployed to [Netlify](https://www.netlify.com/) or [Zeit](https://zeit.co/). Use it to add a glorified build buton, or tie it to cron so that changes are grouped and pushed on whatever schedule you define.
## Features
Quick setup for publishing changes immediately, or collecting them for routine checks via cron:
Dashboard widget for instant deploys:
Run checks or trigger deploys from the command line:
```shell
trigger/deploy/check # Triggers a build if changes are pending.
trigger/deploy/go # Immediately triggers a deploy build.
trigger/deploy/cancel # Cancels pending changes.
```
## Setup
1. Require with `composer require workingconcept/craft-trigger`, then install via CLI or control panel.
2. Visit Settings, set your deploy webhook URL.
3. To batch changes for deploy, add a cron job to run `craft trigger/deploy/check`, which post to your webhook URL only if changes are pending.
4. Optionally add the Dashboard widget to your layout for quick one-click builds.
## How it Works
Saving, reordering, deleting and restoring Elements will either trigger a build or switch on a `pending` flag in the database, depending on the _Deploy on Content Change_ setting you chose. Running `craft trigger/deploy/check` or manually triggering a build from the Dashboard or with `trigger/deploy/go` will reset that flag.
Draft edits won't be flagged as changes.
---
## Support
File an issue and I'll try to respond promptly and thoughtfully. This is a free-time project, so I appreciate your patience.
---
This plugin is brought to you by [Working Concept](https://workingconcept.com).