Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukethacoder/wp-webhook-netlify-deploy
🚢 WP Plugin that adds functionality to easily send Netlify Webhook requests
https://github.com/lukethacoder/wp-webhook-netlify-deploy
deploy-tool deployment-automation gatsbyjs netlify php webhook wordpress-plugin
Last synced: about 1 month ago
JSON representation
🚢 WP Plugin that adds functionality to easily send Netlify Webhook requests
- Host: GitHub
- URL: https://github.com/lukethacoder/wp-webhook-netlify-deploy
- Owner: lukethacoder
- License: gpl-3.0
- Created: 2018-10-10T06:54:28.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-09-22T03:48:18.000Z (about 5 years ago)
- Last Synced: 2024-09-29T14:22:55.028Z (about 1 month ago)
- Topics: deploy-tool, deployment-automation, gatsbyjs, netlify, php, webhook, wordpress-plugin
- Language: PHP
- Homepage: https://wordpress.org/plugins/webhook-netlify-deploy
- Size: 1.64 MB
- Stars: 95
- Watchers: 3
- Forks: 18
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# WP Webhook Netlify Deploy
[](https://github.com/lukethacoder/wp-netlify-webhook-deploy)
## Description
Easily deploy static sites using Wordpress and Netlify
**Build** Quickly and easily send webhooks to build your Netlify
**Schedule** Schedule daily, weekly or monthly builds
**Status** Check the status of your latest build to see if it was successful without even leaving Wordpress
> NOTE: this plugin does not create a static version of your WordPress site. The plugin simply fires off a build request to Netlify, to rebuild your netlify hosted site (which is assumed to be pulling in WordPress data as a headless CMS).
---
## Installation
From your WordPress dashboard
1. **Visit** Plugins > Add New
2. **Search** for "Deploy Webhook Button"
3. **Install** plugin
4. **Activate** the plugin
5. **Click** on the new menu item "Deploy Netlify Webhook" and enter your site details/keys
6. **Enter** enter your site_id, webhook POST address, Netlify API Key, and User-Agent
7. **Read** the documentation to [get started](https://github.com/lukethacoder/wp-netlify-webhook-deploy)
---
## Where do I get the field data from?
### Webhook Build
1. **Visit** Netlify > Site-Name > Settings > Build & Deploy
2. **Create** A Build Hook (or use an existing hook)
3. **Copy** The Build Hook URL into the `Webhook Build URL` field
[](https://github.com/lukethacoder/wp-netlify-webhook-deploy)
### Netlify site_id
1. **Visit** Netlify > Site-Name > Settings
2. **Copy** APP_ID and paste into the `Netlify site_id` field
[](https://github.com/lukethacoder/wp-netlify-webhook-deploy)
### Netlify API Key
1. **Visit** Netlify > User Settings > Applications > Personal Access Tokens
2. **Create** A Personal Access Token (or use an existing one)
3. **Copy** The token and paste into the `Netlify API Key` field
[](https://github.com/lukethacoder/wp-netlify-webhook-deploy)
### User-Agent Site Value
1. **Visit** Netlify > Site-Name > Settings
2. **Copy** The Site Name and paste into the `User-Agent Site Value` field
3. **Add** The site url in brackets to the `User-Agent Site Value` field
4. Your field should look similar to this `SiteNameNoSpaces (site-name-url.com)`
[](https://github.com/lukethacoder/wp-netlify-webhook-deploy)
---
## Scheduling Netlify Builds
Is it possible to set daily, weekly, or monthly builds. Using this plugin. Navigate to the 'Schedule Builds' settings page to select build time and date.
### Consistant Scheduling
WordPress cron jobs are not 100% reliable as they are only fired when the site is visited. A little bit of work may be required to fix this.
#### If you have access to your hosting cPanel
1. **Add** the following to your `wp-config.php` file - `define('DISABLE_WP_CRON', true);`
2. Create a system cron
### Creating a System Cron Job
1. Log into your systems cpanel.
2. Navigate to the Cron Jobs section - Search for "cron"
3. Click "Cron Jobs" (If this does not show up you may not have access to this functionality)
4. Select "Once per hour" from the common settings
5. Add this command to the command input `wget -q -O - https://your-domain.com/wp-cron.php?doing_wp_cron`
#### If you do not have access to your cPanel
A solution to not being able to set up cPanel cron jobs is to use a third party scheduler. This ensures that at a certain time every day your WordPress cron events will fire.
1. Set up an account with https://cron-job.org
2. Login and navigate to "Cronjobs"
3. Create a new cron job for `https://your-domain.com/wp-cron.php?doing_wp_cron` firing a minimum of once an hour every hour.
Now the Netlify hook (and all other cron jobs on your site) will run on time.
---
## Admin Bar
A deploy button and the status badge of the last build is added to the admin bar. By default this will only be displayed to users that can `manage_options`.
You may allow other user roles with these three filters:
```
add_filter('netlify_status_capability', function() {
return 'edit_pages';
});
add_filter('netlify_deploy_capability', function() {
return 'edit_pages';
});
add_filter('netlify_adjust_settings_capability', function() {
return 'edit_pages';
});
```
---
## Screenshots
Main Plugin page
[](https://github.com/lukethacoder/wp-netlify-webhook-deploy)
[](https://github.com/lukethacoder/wp-netlify-webhook-deploy)
---
## Links
- [Website](https://github.com/lukethacoder/wp-netlify-webhook-deploy)
- [Documentation](https://github.com/lukethacoder/wp-netlify-webhook-deploy)
---
## Changelog
View full changelog: [here](https://github.com/lukethacoder/wp-webhook-netlify-deploy/blob/master/CHANGELOG.md)