Skip to content

Latest commit

 

History

History
206 lines (132 loc) · 7.17 KB

README.md

File metadata and controls

206 lines (132 loc) · 7.17 KB
Raw

Eightshift deploy actions

This repository contains the GitHub actions for deploying Eightshift projects.

To use these actions, you need to create a new workflow in your project. You can do that by creating a new YAML (.yml) file in the .github/workflows directory.

Following examples are included in the examples directory:

  • Bundle Artifact - bundles the project into a zip file and attaches it to the artifacts.
  • Bundle Release - bundles the project into a zip file and attaches it to the release.
  • Deploy - deploys the project on the server based on the selected environment and branch.
  • CI - runs checks on the project (e.g. linters, unit tests, ...)
  • Rollback - rollback the project to the previous release.

Bundle Artifact

Bundles the project into a zip file and attaches it to the artifacts. The zip file can be downloaded from the GitHub Actions page.

Following examples are included in the examples/bundle-artifact directory:

  • plugin.yml - bundles the plugin artifact.

Bundle Release

Bundles the project into a zip file and attaches it to the release. The zip file can be downloaded from the GitHub Actions page.

Following examples are included in the examples/bundle-release directory:

  • plugin.yml - bundles the plugin artifact.

Deploy

Deploys the project to the selected environment, from the selected branch. Dropdowns are set up for picking branches and environments for ease of use.

Following examples are included in the examples/deploy directory:

  • infinum-project-with-submodule-theme.yml - deploys the project with the submodule theme (used for internal projects like Infinum Alliance, Academy, Learn, ... that use the submodule theme from the Infinum theme repository).
  • plugin-project-self-hosted-runner.yml - deploys a plugin project with a self-hosted runner.
  • plugin-project.yml - deploys a plugin project.
  • theme-project-self-hosted-runner.yml - deploys a theme project with a self-hosted runner.
  • theme-project.yml - deploys a theme project.

Continuous Integration

Continuous integration (CI) workflows will run tests on the project, and are triggered on every push to the repository.

Following examples are included in the examples/ci directory:

  • plugin-project.yml - runs the tests on plugin projects.
  • plugin.yml - runs the tests on a single plugin.
  • theme-project.yml - runs the tests on theme projects.

Rollback

Rollback workflow is used to rollback the project to the previous version. It is triggered manually by setting the number of releases to rollback.

Current release is number 1, previous release is number 2, and so on.

Following examples are included in the examples/rollback directory:

  • rollback.yml - runs the release action.

Actions

Actions located in the examples/actions directory can be used in all workflows:

  • add-custom-secrets.yml - adds custom secrets to the environment variables from GH secrets.

Secrets

In order to use the deploy action, a few secrets must be added to the repository.

Organization secrets

Responsible person: DevOps or TL

The following secrets are added to the Infinum organization and are shared across all repositories in the organization. They do not need to be added to projects.

  • WORDPRESS_GH_ACTIONS - used for authenticating to GitHub repositories (ask your TL for this secret).

Server secrets

Responsible person: DevOps or TL + Developer

  • SERVER_SSH_KEY - used for the authentication to the server (private key).
  • SERVER_USER - username to connect to the server.
  • SERVER_HOST - hostname to connect to the server.
  • SERVER_PORT - port to connect to the server.
  • SERVER_ROOT - path to the project on the server where the project will be deployed. (relative path from the location you are connecting to using the provided key, without leading and trailing slashes, eg. www/test.com)

Database secrets

Responsible person: DevOps or TL + Developer

  • DB_NAME - database name.
  • DB_USER - database username.
  • DB_PASSWORD - database password.
  • DB_HOST - database host (usually localhost:3306).

Salt secrets

Responsible person: DevOps or TL + Developer

You can generate the salts on the WordPress Salt Generator and add them as secrets.

  • AUTH_KEY
  • SECURE_AUTH_KEY
  • LOGGED_IN_KEY
  • NONCE_KEY
  • AUTH_SALT
  • SECURE_AUTH_SALT
  • LOGGED_IN_SALT
  • NONCE_SALT
  • WP_CACHE_KEY_SALT - used for caching. This salt is not in the default generator output. Make sure you generate it manually.

Other secrets

Responsible person: DevOps or TL + Developer

  • SLACK_WEBHOOK - webhook for the Slack notifications (ask your TL for this secret).
  • BUGSNAG_API_KEY - API key for the Bugsnag notifications (ask your TL for this secret).

Adding custom secrets in the deploy process

Responsible person: DevOps or TL + Developer

To add custom secrets in the deploy process add a custom step after the Setup WordPress step in the deploy action. Keep in mind that the value is always wrapped in single quotes.

	- name: Setup custom secrets as environment variables
		shell: bash
		run: |
			php wp-cli.phar config set S3_UPLOADS_BUCKET_URL '${{ secrets.S3_UPLOADS_BUCKET_URL }}'
			php wp-cli.phar config set S3_UPLOADS_BUCKET '${{ secrets.S3_UPLOADS_BUCKET }}'

			# if you need boolean value use --raw flag
			php wp-cli.phar config set QM_DB_SYMLINK false --raw
			...

Env secrets/variables vs Repository secrets/variables

GitHub offers two types of secrets: variables and secrets. The difference between them is that variables are visible in the logs and in the GUI, while secrets are not. Once set secret can't be viewed again.

Also GitHub offers two types of usage for secrets: repository secrets and environment secrets. The difference between them is that repository secrets are available to all workflows in the repository, while environment secrets are available only to the workflows in the environment and this environment is defined in the workflow file.

When setting up secrets, make sure to use environment secrets and make sure you add them to the correct location and correct type based on the sensitivity of the data.

Env secrets:

  • database related
  • server related
  • auth related (sso, etc.)
  • etc.

Env variables:

  • site url
  • etc.

Repository secrets:

  • slack webhook
  • bugsnag api key
  • integrations that are not environment specific
  • salts
  • plugin/theme specific secrets
  • etc.

Repository variables:

  • any other variables that are not sensitive

Server setup

Responsible person: DevOps

After the deployment the server will switch the current folder with the new symlink from the release folder. This is done to avoid downtime during the deployment but you need to make sure that Nginx is configured properly.

Update the fastcgi_param to use realpath root:

# Default
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;

# Change to
fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;

Point the website root to the current folder:

root <path>/current;

Server structure after the deploy:

  • releases
    • 1
    • 2
    • 3
    • ...
  • current -> releases/3
  • shared
    • uploads
    • ...