Download the PHP package johannschopplich/kirby-deploy-trigger without Composer

On this page you can find all versions of the php package johannschopplich/kirby-deploy-trigger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of johannschopplich/kirby-deploy-trigger

Informations about the package kirby-deploy-trigger

Kirby Deploy Trigger

A Kirby Panel view button to trigger deployments on any CI/CD service, such as Vercel, Netlify, or GitHub Actions.

This is especially useful when you want to trigger a deployment after updating the content in the Panel from your headless Kirby setup. The button sends a request to the specified URL, which can be used to trigger a deployment on your CI/CD service.

Requirements

Kirby is not free software. However, you can try Kirby and the Starterkit on your local machine or on a test server as long as you need to make sure it is the right tool for your next project. … and when you're convinced, buy your license.

Installation

Composer

Download

Download and copy this repository to /site/plugins/kirby-deploy-trigger.

Getting Started

Webhook Setup

Create a webhook in your CI/CD service to listen for incoming requests. The webhook URL is the URL you need to specify in the johannschopplich.deploy-trigger.deployUrl option in the config.php file:

[!TIP] The deployUrl is sent as a POST request by default. You can change the request method with the requestOptions option.

Blueprint Setup

Kirby 5 introduces new extensions that allow you to add custom view buttons to most Panel views (e.g. page, site, or file). The Deploy Trigger plugin provides a button that can be added alongside the default buttons, such as the preview button or the language dropdown.

To add the deploy-trigger button to a particular view, set the buttons option in the corresponding blueprint. The following example shows how to reference the default buttons and add the deploy-trigger button to the site blueprint:

This way, you can reference the default buttons and decide where to place the deploy-trigger button.

[!TIP] Kirby 4 does not support custom view buttons, but the deploy-trigger button has been backported 🎉. It is always prepended to the default buttons and cannot be moved.

Configuration

Each configuration option is available in the config.php file.

The following table lists all available options:

Option Default Description
deployUrl null The URL to trigger the deployment.
requestOptions [] Additional headers or a specific method to send the request.

Cookbook

Trigger a Vercel Deployment

To create a Deploy Hook for your project, make sure your project is connected to a Git repository.

Once your project is connected, navigate to its Settings page and then select the Git menu item.

In the "Deploy Hooks" section, choose a name for your Deploy Hook and select the branch that will be deployed when the generated URL is requested.

After submitting the form, you will see a URL that you can copy and use as the deployUrl option in the config.php file.

License

Johann Schopplich

All versions of kirby-deploy-trigger with dependencies

PHP Build Version
Package Version
Requires getkirby/composer-installer Version ^1.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package johannschopplich/kirby-deploy-trigger contains the following files

Loading the files please wait ....