An open API service indexing awesome lists of open source software.

https://github.com/projektgopher/laravel-workflow-generator

Creates an 'artisan workflow:make' command to scaffold out a number of useful GitHub actions workflows for Laravel
https://github.com/projektgopher/laravel-workflow-generator

Last synced: about 1 month ago
JSON representation

Creates an 'artisan workflow:make' command to scaffold out a number of useful GitHub actions workflows for Laravel

Awesome Lists containing this project

README

        

# Laravel workflow generator
[![Latest Version on Packagist](https://img.shields.io/packagist/v/projektgopher/laravel-workflow-generator.svg?style=flat-square)](https://packagist.org/packages/projektgopher/laravel-workflow-generator)
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/ProjektGopher/Laravel-workflow-generator/run-tests?label=tests)](https://github.com/ProjektGopher/Laravel-workflow-generator/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/ProjektGopher/Laravel-workflow-generator/Check%20&%20fix%20styling?label=code%20style)](https://github.com/ProjektGopher/Laravel-workflow-generator/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/projektgopher/laravel-workflow-generator.svg?style=flat-square)](https://packagist.org/packages/projektgopher/laravel-workflow-generator)

This creates a make:workflow artisan command to scaffold out a number of useful GitHub actions workflows for Laravel.

## Installation

You can install the package via composer:

```bash
composer require projektgopher/laravel-workflow-generator
```

You can publish the config file with:
```bash
php artisan vendor:publish --provider="ProjektGopher\WorkflowGenerator\WorkflowGeneratorServiceProvider" --tag="Laravel-workflow-generator-config"
```

Though you probably won't need to at this point, as there's nothing there.

This is the contents of the published config file:

```php
return [
];
```

## Usage

```bash
php artisan workflow:list
```
Will list out all available workflows to be generated. More will be added.

```bash
php artisan workflow:make dusk
```
Will check for the .github/workflows directory, and create it if it doesn't yet exist.
It will then check that directory for a dusk.yml file.
If one doesn't yet exist, the package will create and populate it.
If it does exist, the package will warn you.

If you've updated the package and want to use a newer version of the workflow,
```bash
php artisan workflow:make dusk --force
```
will overwrite the existing yml file with the newer version.

## Testing

```bash
composer test
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Len Woodward](https://github.com/ProjektGopher)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.