This package was created to optimize and improve a company's CI/CD in a Gitlab environment.
This package version requires PHP 8.1 and supports Laravel 9-11.
Available SSH agents on local machine and remote server.
Remote server must use GNU/Linux.
This package uses GitLab API to create CI/CD variables, powered by package graham-campbell/gitlab.
For deployment uses deployer/deployer.
To render beautiful console output uses nunomaduro/termwind.
You can install this package using Composer:
composer require --dev hexide-digital/gitlab-deploy:^1.3And if you are using composer version 2.4 and above,
we recommend run the bump command to lock latest version:
composer bump "hexide-digital/gitlab-deploy"After installation, this package will automatically register its service provider.
To publish files for deployment and sample files run command bellow:
php artisan deploy:installExamples of files to be copied are located in this folder.
Open .deploy/deploy-prepare.yml
and fill all needed options.
For most cases only need to be specified next options:
- access token for project repository (see tip)
- project id (see tip)
- access to the server
- access to the database
But for every stage are available next options:
- repository url
- executor paths for
phpandcomposer - access for the server
- access to the database
- access to the mail host (but can be omitted)
You can begin configuring your project deployment for specific stage name (i.e. for dev branch) by running:
php artisan deploy:gitlab devNormally, the stage name must be the same as git branch name.
If all tasks completely executed, to enable auto-deployment go to
Settings -> CI/CD -> Variables and change value for CI_ENABLED to 1.
After that, when you edit branch with configured deployment, Gitlab will run CI/CD Pipelines automatically.
If you want to manually execute commands or just prepare to future deployment,
set a --only-print option when calling command.
All commands and examples will be written to log files located in .deploy/logs folder.
All that remains is to copy and execute commands from the file.
In order for variables and other deployment options to be created, you need to grant access to the repository settings. This package uses the Gitlab API method using Access Tokens.
We recommend creating one personal access token and use for future deployment configurations.
For this navigate to Profile -> Access Tokens and press Add new token.
Then fill the next options:
- Token name - name for you to identify token, i.e.
token_for_deployments - Expiration date - by default, automatically specified 1 month, but set longer time or remove this date
- Scopes - this package needs only
apiscope, but you can add more scopes
Then click Create personal access token.
After creating, copy this token and save in somewhere safe place, because you won't be able to access it again, and set in deploy config file
If you don't want to use and create personal token, you can create project token with access only for repository.
To get Access Token follow this path Settings -> Access Tokens and press Add new token.
Fill next options like bellow:
- Token name - any name,
deploy_dev,deploy_prodetc. - Expiration date - recommended to set 1-2 days (this will be enough)
- Role - select
mainterner- this is necessary for the ability to change repository settings - Scopes - select only
api, for this package will be enough
Then click Create project access token to see the token, copy it and set in deploy config file.
Open the main page of the repository and on top you can see repository info and project id. It also can be copied with button on the right side.
Yes! Say hi: [email protected] We will be happy to work with you! Other work we’ve done