https://github.com/jbrooksuk/laravel-forge-action

Deploy your application to Laravel Forge with GitHub Actions.
https://github.com/jbrooksuk/laravel-forge-action

deployment github-actions laravel laravel-forge

Last synced: 7 days ago
JSON representation

Deploy your application to Laravel Forge with GitHub Actions.

• Host: GitHub
• URL: https://github.com/jbrooksuk/laravel-forge-action
• Owner: jbrooksuk
• License: mit
• Created: 2021-01-27T07:43:02.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-29T22:57:38.000Z (over 1 year ago)
• Last Synced: 2024-10-23T11:42:17.506Z (16 days ago)
• Topics: deployment, github-actions, laravel, laravel-forge
• Language: Shell
• Homepage: https://james.brooks.page
• Size: 25.4 KB
• Stars: 81
• Watchers: 4
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel Forge GitHub Action

Deploy your application to [Laravel Forge](https://forge.laravel.com) with GitHub Actions.

## Credit

Heavily based on [Glennmen/ploi-deploy-action](https://github.com/Glennmen/ploi-deploy-action) :heart:

## Inputs

It is highly recommended that you store all inputs using [GitHub Secrets](https://docs.github.com/en/actions/reference/encrypted-secrets).

| Input         | Description                                                                                                                                                                                                             |

|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| `trigger_url` | When using the trigger url to deploy your application, this field is required. You can find this within your site's detail panel in Forge.                                                                              |

| `api_key`     | If you want to use the API to deploy your application, you must provide `api_key`, `server_id` and `site_id`.

You can generate an API key in your [Forge dashboard](https://forge.laravel.com/user-profile/api). |

| `server_id`   | You can find the ID of the server in the server's detail panel.                                                                                                                                                         |

| `site_id`     | You can find the ID of the site in the site's detail panel.                                                                                                                                                             |

## Examples

### Deploy via Deployment Trigger URL

```yml

name: 'Deploy on push'

on:

  push:

    branches:

      - master

jobs:

  forge-deploy:

    name: 'Laravel Forge Deploy'

    runs-on: ubuntu-latest

    steps:

      # Trigger Laravel Forge Deploy

      - name: Deploy

        uses: jbrooksuk/[email protected]

        with:

          trigger_url: ${{ secrets.TRIGGER_URL }}

```

### Deploy via API

```yml

name: 'Deploy on push'

on:

  push:

    branches:

      - master

jobs:

  forge-deploy:

    name: 'Laravel Forge Deploy'

    runs-on: ubuntu-latest

    steps:

      # Trigger Laravel Forge Deploy

      - name: Deploy

        uses: jbrooksuk/[email protected]

        with:

          api_key: ${{ secrets.API_KEY }}

          server_id: ${{ secrets.SERVER_ID }}

          site_id: ${{ secrets.SITE_ID }}

```