Surge.sh Deployment

This page documents deployments using the next major version dpl v2 which currently is in a beta release phase. Please see our blog post for details. The current default version is dpl v1. Check dpl v1 documentation here.

Travis CI can deploy to Surge.sh after a successful build.

For a minimal configuration, add the following to your .travis.yml:

deploy:
  provider: surge
  login: <login>
  token: <encrypted token>
  edge: true # opt in to dpl v2

Status #

Support for deployments to Surge is *stable**.

Known options #

Use the following options to further configure the deployment.

login Surge login (the email address you use with Surge) — required, type: string
token Surge login token (can be retrieved with surge token) — required, secret, type: string
domain Domain to publish to. Not required if the domain is set in the CNAME file in the project folder. — type: string
project Path to project directory relative to repo root — type: string, default: .

Shared options #

cleanup Clean up build artifacts from the Git working directory before the deployment — type: boolean
run Commands to execute after the deployment finished successfully — type: string or array of strings

Environment variables #

All options can be given as environment variables if prefixed with SURGE_.

For example, token can be given as SURGE_TOKEN=<token>.

Securing secrets #

Secret option values should be given as either encrypted strings in your build configuration (.travis.yml file) or environment variables in your repository settings.

Environment variables can be set on the settings page of your repository, or using travis env set:

travis env set SURGE_TOKEN <token>

In order to encrypt option values when adding them to your .travis.yml file use travis encrypt:

travis encrypt <token>

Or use --add to directly add it to your .travis.yml file. Note that this command has to be run in your repository’s root directory:

travis encrypt --add deploy.token <token>

Specifying a project directory #

By default it is assumed that the repository root contains the files to deploy.

In order to specify a different project directory use the option project:

deploy:
  provider: surge
  # ⋮
  project: ./static

Pull Requests #

Note that pull request builds skip the deployment step altogether.

See also #