README

The repository contains Deployer configuration for Magento2 and example of Github Actions workflow. The workflow creates events on push into dev/test/master branches and initiate a deployment process to dev/test/master servers, correspondingly.

You need to follow this simple steps to integrate in your project:

1. Copy deploy.yml from the repo to .github/workflow folder

2. Copy hosts.yml to root folder and fill the file with your data

3. Copy deploy.php to root folder if you want to override some tasks

4. Create required DEPLOY_KEY secret in the settings on your repository, it will be used for connect to servers

5. Prepare shared folder on your servers:

• copy app/etc/env.php from current document root to #deploy_path#/shared/app/etc/env.php
• copy all media files from pub/media to #deploy_path#/shared/pub/media

1. Be sure all deployment steps are going right on servers (take care about composer/ssh keys)

2. Push a commit to dev/test/master branch!

Configuration

Git LFS

By default, Git LFS files are skipped during deployment (skip_lfs: true). This prevents large LFS objects (e.g., local database backups) from being downloaded to servers, saving both deployment time and disk space.

To disable this, set skip_lfs: false in your hosts.yml:

production:
  hostname: prod-server
  remote_user: deploy
  skip_lfs: false

Note: The skip_lfs option uses set('env', ...) to configure the GIT_LFS_SKIP_SMUDGE environment variable. If your project needs additional environment variables, add them inside the same closure in deploy.php rather than calling set('env', ...) separately, which would overwrite the LFS setting.

Related links:

https://deployer.org

https://help.github.com/en/github/automating-your-workflow-with-github-actions