Skip to content

Hi-Folks/gh-actions-yaml-generator

Repository files navigation

GitHub Workflow Status (main branch) GitHub release (latest by date) Website

Ghygen

Ghygen

Ghygen is a GitHub actions Yaml Generator.

Ghygen allows you creating your Yaml file for GitHub Actions, for Laravel/PHP web application, so you can:

  • select triggering events: manually or automatically, when the developer push the code on a specific branch, or a developer create a new Pull Request;
  • select branches;
  • enable caching for all vendors;
  • enable caching PHP packages;
  • select multiple PHP versions (8.2, 8.1, 8.0, 7.4);
  • select multiple Laravel versions (10, 9, 8, 7, 6), useful if you are developing a Laravel Package and you want to test it with multiple Laravel version;
  • select Node version for NPM (executing scripts via npm run);
  • caching node packages;
  • setup Mysql Database service;
  • setup PostgreSQL Database service;
  • setup Sqlite in memory database;
  • run migrations;
  • execute tests via phpunit;
  • execute tests via PestPHP;
  • static code analysis with phpstan or psalm;
  • create Sarif report (with Psalm) for GitHub integration with code scanning;
  • code sniffer (via phpcs for PSR12 compatibility);
  • validate Yaml file;
  • execute Browser Test via Laravel Dusk.
  • Run Deployments via Ploi using Ploi Deploy Action.

This is a Work In Progress, we are adding new features...

If you want to test and use quickly this tool, I deployed the codebase (main branch) on Digital Ocean Platform:

If you want to start using it locally you can clone the repo and install it following the instructions below.

Command line

Experimental and "magical" feature: Ghygen ships also a command for generating automatically a GitHub Actions workflow Yaml file. You can install Gygen as project with composer:

composer create-project hi-folks/ghygen
cd ghygen

Once you installed Ghygen, you can execute:

php artisan ghygen:generate --projectdir=../otherproject

Where "../otherproject" is the directory (absolute or relative path name) with your Laravel project (application or package) that yuo want to automatically generate the GitHub Actions workflow yaml file. This "magic" command, will extract information from:

  • composer.json
  • package.json (if it exists)
  • .env file
  • ... and other assets
  • in order to guess a configuration for your GitHub Actions workflow.

By default the command will show the Yaml workflow file in the standard output. If you want to save it in a file for example "my-workflow.yml" you can use --save option:

php artisan ghygen:generate  --save=my-workflow.yml

If you want to autogenerate Yaml file in the .github/workflows directory use --save=auto

php artisan ghygen:generate  --save=auto

The file name will be created with the name found in composer.json (slugified).

So if you are superlazy and want to generate the workflow for the project in the directory ../myproject , you can execute:

php artisan ghygen:generate --projectdir=../myproject/ --save=auto

Install

Clone source code, enter the new directory and perform a couple of instructions:

git clone https://github.com/Hi-Folks/gh-actions-yaml-generator.git
cd gh-actions-yaml-generator
make install

Then create your database and update the .env file with the right values for DB_* .

Once your Database is configured you can execute the migrations:

php artisan migrate

Start development server

php artisan serve

Open the browser to the URL: http://127.0.0.1:8000

Usage

Follow these steps:

  • access to the form (by default the URL is http://127.0.0.1:8000 if you run php artisan serve);
  • fill the form;
  • click on "Generate Yaml File" button.

github-actions-generator-laravel

Next, copy the content of your generated Yaml in a new file in your Laravel project .github/workflows/laravel_workflow.yaml .

Commit and push the new file.

If you configured "On - Push" you will see the running Actions in your Actions section of your GitHub project.

Thanks to

Thanks to all the people for providing feedback, opening issues, creating Pull Requests. Thank you to all the contributors! You can see the list of contributors at this section.

In the PHP ecosystem, we have many tools that help developers work with great productivity, reliability, and efficiency. One of these tools is JetBrains PHP Storm. JetBrains supports the open-source community by providing licenses for open-source projects. You can find more information in the Open Source section of the JetBrains website.

PhpStorm logo

JetBrains is providing me the license for the Ghygen project. This fills me with joy, because Ghygen has been recognized as a deserving open-source software. Thank you.