https://github.com/log1x/envoyer-deploy-commands

Simple deployment with Envoyer using Artisan
https://github.com/log1x/envoyer-deploy-commands

artisan envoyer laravel

Last synced: about 10 hours ago
JSON representation

Simple deployment with Envoyer using Artisan

• Host: GitHub
• URL: https://github.com/log1x/envoyer-deploy-commands
• Owner: Log1x
• License: mit
• Created: 2023-09-11T22:24:50.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-17T10:25:26.000Z (7 months ago)
• Last Synced: 2024-09-19T14:48:36.007Z (14 days ago)
• Topics: artisan, envoyer, laravel
• Language: PHP
• Homepage: https://github.com/Log1x/envoyer-deploy-commands
• Size: 58.6 KB
• Stars: 25
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![Screenshot](https://i.imgur.com/9987R1B.gif)

# Envoyer Deploy Commands

![Latest Stable Version](https://img.shields.io/packagist/v/log1x/envoyer-deploy-commands.svg?style=flat-square)

![Total Downloads](https://img.shields.io/packagist/dt/log1x/envoyer-deploy-commands.svg?style=flat-square)

![Build Status](https://img.shields.io/github/actions/workflow/status/log1x/envoyer-deploy-commands/main.yml?branch=main&style=flat-square)

Envoyer Deploy Commands is a simple Laravel package providing Artisan commands to deploy through [Envoyer](https://envoyer.io/) using the API.

## Requirements

- [PHP](https://secure.php.net/manual/en/install.php) >= 8.1

- [Laravel](https://laravel.com/) >= 9.0

## Installation

Install via Composer:

```bash

$ composer require log1x/envoyer-deploy-commands --dev

```

## Getting Started

Start by publishing the package configuration:

```bash

$ php artisan vendor:publish --tag=envoyer-deploy-config

```

Customize the configuration adding your Envoyer API key with the `deployments:create` permission scope.

After adding an API key, you can list the available projects and their corrosponding ID's:

```bash

$ php artisan deploy:list [search]

```

Once you have your project ID, add it the `projects` section of `config/envoyer.php` along with an alias (e.g. `production`).

## Usage

Usage is extremely straight forward. Use the `artisan deploy` command optionally specifying your project alias. If you only have 1 project, it will be used by default.

```bash

$ php artisan deploy [alias]

```

You can also get detailed information on your project using the `artisan deploy:info` command:

```bash

$ php artisan deploy:info [alias]

```

![Info Screenshot](https://i.imgur.com/u4Gq7sX.png)

## Bug Reports

If you discover a bug in Envoyer Deploy Commands, please [open an issue](https://github.com/Log1x/envoyer-deploy-commands/issues).

## Contributing

Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated.

## License

Envoyer Deploy Commands is provided under the [MIT License](LICENSE.md).