Deployments

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

1# File: .github/workflows/edgio.yml
2# Purpose: Deploy to Edgio upon specific GitHub events.
3
4# Deployment Rules:
5# - "main" branch -> Default Environment
6# - Feature branch -> Staging (on PR)
7# - GitHub Release -> Production
8
9# Prerequisites:
10# - Set "EDGIO_DEPLOY_TOKEN" secret, generated from https://edgio.app
11# - Add `edgio:deploy` in package.json (Example: https://github.com/edgio-docs/edgio-docs/blob/main/package.json#L9)
12# - Create additional staging and production environments in https://edgio.app
13
14name: Deploy branch to Edgio
15
16on:
17  push:
18    branches: [main]
19  pull_request:
20  release:
21    types: [published]
22
23jobs:
24  deploy-to-edgio:
25    name: Deploy to Edgio
26    # Skip for auto-merge push on release tagging
27    if: contains(github.ref, 'refs/tags') == false || github.event_name == 'release'
28    runs-on: ubuntu-latest
29    env:
30      deploy_token: ${{ secrets.EDGIO_DEPLOY_TOKEN }}
31
32    steps:
33      # Validate presence of deploy token
34      - name: Validate Deploy Token
35        if: env.deploy_token == ''
36        run: echo "EDGIO_DEPLOY_TOKEN missing" && exit 1
37
38      # Extract and sanitize branch name
39      - name: Extract Branch Name
40        shell: bash
41        run: echo "BRANCH_NAME=$(echo ${GITHUB_REF#refs/heads/} | sed 's/\//_/g')" >> $GITHUB_ENV
42
43      # Checkout code and set up Node.js
44      - uses: actions/checkout@v1
45      - uses: actions/setup-node@v1
46        with:
47          node-version: 16
48
49      # Cache node modules
50      - name: Cache Node Modules
51        uses: actions/cache@v1
52        with:
53          path: ~/.npm
54          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
55          restore-keys: |
56            ${{ runner.os }}-build-${{ env.cache-name }}-
57            ${{ runner.os }}-build-
58            ${{ runner.os }}-
59
60      # Install packages (Adjust based on package manager)
61      - name: Install Packages
62        run: npm ci
63
64      # Deploy
65      - name: Deploy to Edgio
66        run: npm run edgio:deploy -- --branch=$BRANCH_NAME --token=$deploy_token \
67          ${{ github.event_name == 'push' && '--environment=default' || '' }} \
68          ${{ github.event_name == 'pull_request' && '--environment=staging' || '' }} \
69          ${{ github.event_name == 'release' && '--environment=production' || '' }}

1// Add this file to your project at ./Jenkinsfile
2//
3// This Jenkins pipeline deploys your site on Edgio.
4//
5// The site is deployed each time commits are pushed. The environment to which the changes are deployed
6// is based on the following rules:
7//
8// 1.) When pushing to `master`, changes are deployed to the "staging" environment. This environment does not exist
9//     by default. You must create it using https://edgio.app.
10// 2.) When pushing to any other branch, changes are deployed to the default environment. An unique URL is created
11//     based on the branch and deployment number.
12// 3.) To deploy to the "production" environment, use https://edgio.app to promote the build. This environment does not
13//     exist by default, you must create it using https://edgio.app.
14//
15// In order for this pipeline to deploy your site, you must create a deploy token from the site settings page
16// in https://edgio.app and configure it as an environment variable called "edgio_deploy_token" in your Jenkins configuration.
17
18pipeline {
19  agent {
20    docker {
21      image "node:14-alpine"
22    }
23  }
24  environment {
25    REPO_URL = "https://github.com/{your-org}/{your-repo}/" // (required)
26
27    npm_config_cache = "npm-cache"
28    HOME = "."
29  }
30  stages {
31    stage("Checking environment") {
32      when {
33        expression {
34          env.edgio_deploy_token == null
35        }
36      }
37      steps {
38        echo "You must define the 'edgio_deploy_token' secret in your environment variables"
39        sh "exit 1"
40      }
41    }
42    stage("Install packages") {
43      steps {
44        sh "npm i"
45      }
46    }
47    stage("Deploy to Edgio") {
48      steps {
49        script {
50          def branch = env.GIT_BRANCH // typically referenced as `origin/{branch}`
51          def url = env.REPO_URL
52          env.EDGIO_COMMIT_URL = (url.endsWith("/") ? url : url + "/") + "commit/$GIT_COMMIT"
53          env.BRANCH_NAME = branch.tokenize("/").last()
54          env.EDGIO_ENV_ARG = (env.BRANCH_NAME != "master") ? "--branch=$BRANCH_NAME" : "--environment=staging"
55        }
56        sh "npm run deploy -- --token=$edgio_deploy_token ${EDGIO_ENV_ARG} --commit-url=${EDGIO_COMMIT_URL}"
57      }
58    }
59  }
60}

1# Add this file to your project at .gitlab-ci.yml
2#
3# This GitLab CI/CD configuration deploys your site on Edgio.
4#
5# The site is deployed each time commits are pushed. The environment to which the changes are deployed
6# is based on the following rules:
7#
8# 1.) When pushing to master or main, changes deployed to the "staging" environment. This environment does
9#     not exist by default. You must create it using https://edgio.app.
10# 2.) When pushing to any other branch, changes are deployed to the default environment. A unique URL is
11#     created based on the branch and deployment number.
12# 3.) When you push a tag to GitLab, it will be deployed to the production environment. This environment does
13#     not exist by default, you must create it using https://edgio.app. Therefore, you can push to
14#     production by creating a tag, or by using the "Promote to Environment" menu when viewing a deployment
15#     in https://edgio.app.
16#
17# In order for this pipeline to deploy your site, you must create a deploy token from the site settings page
18# in https://edgio.app and configure it as a variable called "EDGIO_DEPLOY_TOKEN" in your GitLab
19# project's settings page. You should mask this variable to prevent it from appearing in logs.
20
21image: node:16
22
23stages:
24  - deploy
25
26cache:
27  key: npm
28  paths:
29    - .npm/
30
31edgio_deploy:
32  stage: deploy
33  rules:
34    - if: '$CI_PIPELINE_SOURCE != "push"'
35      when: never
36    - if: '$CI_COMMIT_BRANCH == "master" || $CI_COMMIT_BRANCH == "main"'
37      variables:
38        EDGIO_DEPLOY_ENVIRONMENT: 'staging'
39    - if: '$CI_COMMIT_TAG'
40      variables:
41        EDGIO_DEPLOY_ENVIRONMENT: 'production'
42    - if: '$CI_COMMIT_BRANCH'
43      variables:
44        EDGIO_DEPLOY_ENVIRONMENT: ''
45  before_script:
46    - npm ci --cache .npm --prefer-offline
47  script:
48    - npm run edgio:deploy -- --token="$EDGIO_DEPLOY_TOKEN" --non-interactive --branch="$CI_COMMIT_BRANCH" --environment"$EDGIO_DEPLOY_ENVIRONMENT"