juzaweb/auto-deploy

Automate deployment deployment using git and webhooks

Maintainers

Details

github.com/juzaweb/auto-deploy

Homepage

Source

Issues

Installs: 8

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 1

Forks: 0

Open Issues: 0

Type:juzaweb-plugin

1.1.2 2024-03-24 03:26 UTC

Requires (Dev)

MIT b65bd79d34eec004002ff17b0a5c6369569f483e

This package is auto-updated.

Last update: 2024-11-24 05:03:12 UTC

README

Auto deployment using git and webhooks plugin

Set up Automated Deployments From GitHub With Webhook

  • Setup config in file .env
DEPLOY_ENABLE=true
DEPLOY_GITHUB_SECRET=<random-string>
  • Make drploy token, run command
php artisan deploy:make-token
  • Set up command on build, make .deploy.yml in root your source folder.

Example:

github-deploy:
  commands:
    - git pull
    - composer install --no-dev
    - php artisan migrate --force
  • Add a repository webhook on GitHub

To add a webhook to an existing repository, navigate to the GitHub repository page and go to "Settings" > "Webhooks". Click on "Add webhook".

  • Payload URL — A custom domain that points to your server or your server's public IP, followed by
https://yourdomain.com/webhook/deploy/github/{action}/{token}

{action}: Action define in your file .deploy.yml, example above, the action will be github-deploy

{token}: Your token created above

  • Secret — A shared secret DEPLOY_GITHUB_SECRET in .env
  • Which events would you like to trigger this webhook? (Default option: "Just the push event.")
IF YOU WANT TO ADD CUSTOM PARAM TO YOUR COMMANDS ADD QUERY STRING TO WEBHOOK URL

Example:

Webhook Url:

https://yourdomain.com/webhook/deploy/github/{action}/{token}?theme=default

In file .deploy.yml

github-deploy:
  commands:
    - cd themes/{theme}
    - git pull