Overview

Woodpecker CI plugin that triggers a Laravel Forge deployment.

Heavily based on jbrooksuk/laravel-forge-action.

Settings

Settings Name	Default	Description
trigger_url	none	Forge deployment trigger URL. Found in your site's detail panel in Forge.
api_key	none	Forge API key. Generate one at https://forge.laravel.com/user-profile/api. Requires server_id and site_id.
server_id	none	Forge server ID. Found in the server's detail panel.
site_id	none	Forge site ID. Found in the site's detail panel.
query	none	Optional. Extra query string appended to trigger_url (e.g. tag=v1.0.0). Do not include a leading ?.

If both trigger_url and api_key are set, trigger_url takes precedence. It is highly recommended to store all settings using Woodpecker secrets.

Examples

Trigger URL mode

steps:
  deploy:
    image: njaaazi/laravel-forge-woodpecker:latest
    settings:
      trigger_url:
        from_secret: forge_trigger_url
    when:
      - branch: main
        event: push

Pass extra query params (e.g. a tag) via query:

steps:
  deploy:
    image: njaaazi/laravel-forge-woodpecker:latest
    settings:
      trigger_url:
        from_secret: forge_trigger_url
      query: "tag=${CI_COMMIT_TAG}"
    when:
      - event: tag

API mode

steps:
  deploy:
    image: njaaazi/laravel-forge-woodpecker:latest
    settings:
      api_key:
        from_secret: forge_api_key
      server_id:
        from_secret: forge_server_id
      site_id:
        from_secret: forge_site_id
    when:
      - branch: main
        event: push