Deployments

A deployment is required to apply changes to your code or configuration to an environment.

Deploying

Deploy to an environment using either of the following methods:

Edgio Console: Use this method to deploy changes made within the Edgio Console.
1. Load the desired environment.
  1. From the Edgio Console, select the desired private or team space.
  2. Select the desired property.
  3. From the left-hand pane, select the desired environment from under the Environments section.
2. Update your hostname, origin, or rule configuration.
3. From the notification bar at the top of the page, click Deploy Changes.
Edgio CLI: Use this method to deploy changes from your local machine (e.g., changes to edgio.config.js or routes.[js|ts]).
Bash
1edgio deploy [<TEAM>] [--environment=<ENVIRONMENT>]
If you omit the environment argument, then the deployment will be applied to the production environment.

The CLI will automatically detect your property’s framework, create an optimized production build, and upload it to Edgio. This takes about a minute for most applications.

Once the deployment is complete, the CLI will output the URL for your site. Your property’s name is automatically derived from the name field in package.json. This can be overridden by using --property option when running edgio deploy.

Versioning

Deployments are versioned. Each deployment is assigned a unique version number. This allows you to quickly roll back to a previous version when a breaking change is introduced into an environment.

To roll back to a previous version

Load the Deployments page.
1. From the Edgio Console, select the desired private or team space.
2. Select the desired property.
3. From the left-hand pane, select the desired environment from under the Environments section.
4. From the left-hand pane, select Deployments.
Find the deployment that should be applied to this environment, click its
icon, and then click Rollback to this version.
When prompted, click Promote to production to confirm that a previous deployment will be applied to this environment.

Each time you deploy your site to Edgio a deployment is created and given a unique and permanent URL based on the team name, site name, branch name in source control, and an incrementing deployment number. If you use Git, the branch name is set by the default. If not, you can specify the --branch option when running edgio deploy.

Having each deployment be simultaneously and permanently accessible makes it easy to preview other developers’ work before merging a pull request and enables you to “go back in time” to find where a bug or change in behavior originated. We recommend configuring your CI environment to deploy every push to Edgio.

Deploy from CI

When configuring CI, we recommend:

Automatically deploying to your staging environment when a PR is merged to the master branch of your repo.
Manually promoting deployments to production using the Edgio Console to prevent unwanted builds from being published by misconfigured CI workflows.

A deploy token is required to deploy from your CI environment. Create one from the Settings page in the Edgio Console.

Use the --token option when deploying from your CI script:

Bash
edgio deploy my-site --token=$EDGIO_DEPLOY_TOKEN

You should always store your deploy token using your CI environment’s secrets manager. Never commit your deploy token to source control.

GitHub Actions

You need to configure the following items in order to get a GitHub action set up.

Create a deploy token (see Deploying from CI). Copy the value of that token for use in the next step.
Save the deploy token inside GitHub (more info). Go to your GitHub project > Settings > Secrets > New repository secret. Save the item as EDGIO_DEPLOY_TOKEN.
Inside your development project, create a top level folder titled .github. Inside that create a workflows folder. From there create a edgio.yml file and use the example below for its content.

This is an example GitHub action that will deploy your site to Edgio.

For this action to work

By default, new Edgio sites are created with a default environment. The action below will create a new build for every push on the default environment.
To leverage the GitHub release workflow part of the action below, you need to create an environment production.
You need to have created a deploy key for your site (see above) and added it as a secret in your repo called “edgio_deploy_token”. Read more on accessing environment variables which might be essential for your app during the build time and for server-side requests (including SSG/SSR).
Depending on your use of NPM or YARN, adjust the “Install packages” step

Read the comments at the top to understand how this action is configured.

Template

YAML
# Add this file to your project at .github/workflows/edgio.yml
#
# This GitHub action deploys your site on Edgio.
#
# The site is deployed each time commits are pushed. The environment to which the changes are deployed
# is based on the following rules:
#
# 1.) When pushing to master or main, changes will be deployed to the "default" environment. This environment exists
#     by default. Additional environments must be created at https://edgio.app.
#
# 2.) When pushing to any other branch, changes are deployed to a staging environment when a pull request is opened.
#     A unique URL is created based on the branch and deployment number. This environment does not exist by default,
#     you must create it using https://edgio.app.
#
# 3.) When you publish a release in GitHub, the associated tag will be deployed to the production
#     environment. You can push to production by creating a GitHub release, or by using the "Promote to Environment"
#     menu when viewing a deployment in https://edgio.app. This environment does not exist by default,
#     you must create it using https://edgio.app.
#
# ** In order for this action to deploy your site, you must create a deploy token from the site settings page
# ** In order for this action to deploy your site, you must create a `deploy` command in your package.json scripts (an example is at https://github.com/layer0-docs/layer0-docs/blob/master/package.json#L11).
# ** Additionally, you will need to generate a deploy token from your site settings in https://edgio.app and configure it as a secret called "EDGIO_DEPLOY_TOKEN" in your repo on GitHub.
#
# ** Depending on your use of NPM or YARN, adjust the "Install packages" step

name: Deploy branch to Edgio

on:
  push:
    branches: [master, main]
  pull_request:
  release:
    types: [published]

jobs:
  deploy-to-edgio:
    name: Deploy to Edgio
    # cancels the deployment for the automatic merge push created when tagging a release
    if: contains(github.ref, 'refs/tags') == false || github.event_name == 'release'
    runs-on: ubuntu-latest
    env:
      deploy_token: ${{secrets.EDGIO_DEPLOY_TOKEN}}
    steps:
      - name: Check for Edgio deploy token secret
        if: env.deploy_token == ''
        run: |
          echo You must define the "EDGIO_DEPLOY_TOKEN" secret in GitHub project settings
          exit 1
      - name: Extract branch name
        shell: bash
        run: echo "BRANCH_NAME=$(echo ${GITHUB_REF#refs/heads/} | sed 's/\//_/g')" >> $GITHUB_ENV
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          node-version: 14
      - name: Cache node modules
        uses: actions/cache@v1
        env:
          cache-name: cache-node-modules
        with:
          path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
          key: ${{ runner.os }}-build-${{ env.cache-name }}-$&lcub;&lcub; hashFiles&lpar;&apos;&midast;&midast;&sol;package-lock&period;json&apos;&rpar; &rcub;&rcub;
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
            ${{ runner.os }}-
      - name: Install packages
        run: npm ci # if using npm for your project
        #  run: rm -rf node_modules && yarn install --frozen-lockfile # if using yarn for your project
      - name: Deploy to Edgio
        run: |
          npm run deploy -- ${{'--branch=$BRANCH_NAME' || ''}} --token=$deploy_token  \
          ${{github.event_name == 'push' && '--environment=default' || ''}} \
          ${{github.event_name == 'pull_request' && '--environment=staging' || ''}} \
          ${{github.event_name == 'release' && '--environment=production' || ''}}
        env:
          deploy_token: ${{secrets.EDGIO_DEPLOY_TOKEN}}

Screencast Tutorial

Jenkins Pipeline

Here is an example Jenkins pipeline that deploys your site to Edgio:

This guide assumes:

Your project is hosted on GitHub
You have a Jenkins environment configured with Docker and to receive GitHub push events
You have created environments called “staging” and “production”
You have created a deploy key for your site and added it as an environment variable in your Jenkins configuration called “edgio_deploy_token”.

Groovy
// Add this file to your project at ./Jenkinsfile
//
// This Jenkins pipeline deploys your site on Edgio.
//
// The site is deployed each time commits are pushed. The environment to which the changes are deployed
// is based on the following rules:
//
// 1.) When pushing to `master`, changes are deployed to the "staging" environment. This environment does not exist
//     by default. You must create it using https://edgio.app.
// 2.) When pushing to any other branch, changes are deployed to the default environment. An unique URL is created
//     based on the branch and deployment number.
// 3.) To deploy to the "production" environment, use https://edgio.app to promote the build. This environment does not
//     exist by default, you must create it using https://edgio.app.
//
// In order for this pipeline to deploy your site, you must create a deploy token from the site settings page
// in https://edgio.app and configure it as an environment variable called "edgio_deploy_token" in your Jenkins configuration.

pipeline {
  agent {
    docker {
      image "node:14-alpine"
    }
  }
  environment {
    REPO_URL = "https://github.com/{your-org}/{your-repo}/" // (required)

    npm_config_cache = "npm-cache"
    HOME = "."
  }
  stages {
    stage("Checking environment") {
      when {
        expression {
          env.edgio_deploy_token == null
        }
      }
      steps {
        echo "You must define the 'edgio_deploy_token' secret in your environment variables"
        sh "exit 1"
      }
    }
    stage("Install packages") {
      steps {
        sh "npm i"
      }
    }
    stage("Deploy to Edgio") {
      steps {
        script {
          def branch = env.GIT_BRANCH // typically referenced as `origin/{branch}`
          def url = env.REPO_URL
          env.EDGIO_COMMIT_URL = (url.endsWith("/") ? url : url + "/") + "commit/$GIT_COMMIT"
          env.BRANCH_NAME = branch.tokenize("/").last()
          env.EDGIO_ENV_ARG = (env.BRANCH_NAME != "master") ? "--branch=$BRANCH_NAME" : "--environment=staging"
        }
        sh "npm run deploy -- --token=$edgio_deploy_token ${EDGIO_ENV_ARG} --commit-url=${EDGIO_COMMIT_URL}"
      }
    }
  }
}

GitLab CI/CD

Here is an example GitLab CI/CD configuration that deploys your site to Edgio:

This guide assumes:

Your repository is hosted on GitLab
Your default git branch is named master or main
You have created environments called “staging” and “production”
You have created a deploy key for your site and added it as a variable in your GitLab project’s CI/CD settings page, named “EDGIO_DEPLOY_TOKEN”

YAML
# Add this file to your project at .gitlab-ci.yml
#
# This GitLab CI/CD configuration deploys your site on Edgio.
#
# The site is deployed each time commits are pushed. The environment to which the changes are deployed
# is based on the following rules:
#
# 1.) When pushing to master or main, changes deployed to the "staging" environment. This environment does
#     not exist by default. You must create it using https://edgio.app.
# 2.) When pushing to any other branch, changes are deployed to the default environment. A unique URL is
#     created based on the branch and deployment number.
# 3.) When you push a tag to GitLab, it will be deployed to the production environment. This environment does
#     not exist by default, you must create it using https://edgio.app. Therefore, you can push to
#     production by creating a tag, or by using the "Promote to Environment" menu when viewing a deployment
#     in https://edgio.app.
#
# In order for this pipeline to deploy your site, you must create a deploy token from the site settings page
# in https://edgio.app and configure it as a variable called "EDGIO_DEPLOY_TOKEN" in your GitLab
# project's settings page. You should mask this variable to prevent it from appearing in logs.

image: node:14

stages:
  - deploy

cache:
  key: npm
  paths:
    - .npm/

edgio_deploy:
  stage: deploy
  rules:
    - if: '$CI_PIPELINE_SOURCE != "push"'
      when: never
    - if: '$CI_COMMIT_BRANCH == "master" || $CI_COMMIT_BRANCH == "main"'
      variables:
        EDGIO_DEPLOY_PARAM: ' --environment=staging'
    - if: '$CI_COMMIT_TAG'
      variables:
        EDGIO_DEPLOY_PARAM: ' --environment=production'
    - if: '$CI_COMMIT_BRANCH'
      variables:
        EDGIO_DEPLOY_PARAM: ''
  before_script:
    - npm ci --cache .npm --prefer-offline
  script:
    - npm run edgio:deploy -- --token="$EDGIO_DEPLOY_TOKEN" --non-interactive --branch="$CI_COMMIT_BRANCH$EDGIO_DEPLOY_PARAM"