Skip to content

deployment-automation.md

Latest commit

 

History

History
33 lines (21 loc) · 1.99 KB

deployment-automation.md

File metadata and controls

33 lines (21 loc) · 1.99 KB

Reference for deployment automation

This repository is configured to automatically deploy theme updates to our staging and production servers via GitHub Actions (see ADR0004).

Requirements

  1. The repository itself is configured to use self-hosted runners (see Add Self-Hosted Runners)
  2. The Omeka S host server has the GitHub Runner application installed
  3. There are two GitHub Actions workflows in this repository, one for deploys to the stage server and one for deploys to the production server.
  4. There is a special user, mitdeploy on the Digital Scholar hosted server that has very limited privileges (limited to read/write/delete on the themes and modules directories for the Omeka install).

GitHub Runner Installation

Head to Settings > Actions > Runners for the repo and click the New self-hosted runner button. This will generate the necessary commands a token for the installation on the host server. Two other important notes.

  1. Make sure to set a label and a name for the running when running the config command with the following parameters --labels <ENV> --name <NAME> (where <ENV> is either stage or prod and is either mitlibraries-stage-omeka or mitlibraries-prod-omeka). These values are used in the GitHub Actions to limit where tasks are run.
  2. Configure the runner package to run as a service (see github runner as a service for details)

Workflow configuration

When creating the GitHub Actions workflows, be sure to specify

    runs-on: [self-hosted, Linux, stage]

for the stage runner/server and specify

    runs-on: [self-hosted, Linux, prod]

for the production runner/server.