Stars: 314
Forks: 34
Pull Requests: 106
Issues: 49
Watchers: 9
Last Updated: 2023-05-27 14:30:53
Ghygen is a GitHub Actions configurator for your PHP / Laravel project.
License: MIT License
Languages: Shell, PHP, Blade, Makefile
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:
npm run
);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.
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:
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
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
Follow these steps:
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 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.
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.