travis-deploy-once

Run a deployment script only once in the Travis test matrix.

On Travis builds running multiple jobs (to test with multiple Node versions and/or OSs), run some code from the after_success phase only once, after all other jobs have completed successfully.

Your code will run only on the job identified as the build leader, which is determined as follow, by order of priority:

• The job with the ID defined in the -b, --buildLeaderId CLI options or the buildLeaderId API option or BUILD_LEADER_ID environment variable.
• The job configured with the latest Node version (node_js: node).
• The job configured with the lts Node version (node_js: lts/*).
• The job with the highest node version

Note: If multiple jobs match, the one with the highest job ID (which corresponds to the last one defined in .travis.yml) will be identified as the build leader.

CLI

CLI usage

In .travis.yml:

language: node_js
node_js:
  - 8
  - 6
  - 4
os:
  - osx
  - linux
after_success:
  - npm install -g travis-deploy-once
  - travis-deploy-once "deploy-script --script-arg script-arg-value"

The script deploy-script will be called only for the node 8 job running on linux. It will be passed the arguments --script-arg script-arg-value.

CLI options

-t, --githubToken

Type: String Default: GH_TOKEN or GITHUB_TOKEN environment variable

GitHub OAuth token.

-b, --buildLeaderId

Type: Number Default: BUILD_LEADER_ID environment variable

Define which Travis job will run the script (build leader). If not defined the build leader will be the Travis job running on the highest Node version.

-p, --pro

Type: Boolean Default: false

true to use Travis Pro, false to use Travis for Open Source.

-u, --travis-url

Type: String Default: TRAVIS_URL environment variable

Travis Enterprise URL. If defined, the -p, --pro option will be ignored.

Note: This is the URL of the API endpoint, for example https://travis.example.com/api.

-h, --help

Type: Boolean

Show help.

-v, --version

Type: Boolean

Show version number.

API

API usage

npm install --save travis-deploy-once

In the module my-module:

const deployOnce = require('travis-deploy-once');

try {
  const result = await deployOnce({travisOpts: {pro: true}, githubToken: 'xxxxxx', buildLeaderId: 1});

  if (result === true) deployMyThing();
  if (result === false) console.log('Some job(s) failed');
  if (result === null) console.log('Did not run as the build leader');
} catch (err) {
  // something went wrong, and err will tell you what
}

In .travis.yml:

language: node_js
node_js:
  - 8
  - 6
  - 4
os:
  - osx
  - linux
after_success:
  - npm run my-module

The script my-module with be called for each node version on both OSs and deployMyThing will be called only for the node 8 job running on linux.

Function deployOnce([options])

Returns a Promise that resolves to:

• true if the current Travis job is the build leader, the current script phase is successful and all other job have completed successfully. => Your code can safely run.
• false if at least one Travis job failed. => Your code should not run.
• null if the current Travis job is not the build leader. => Your code should not run, and will be executed on the build leader.

Throws an Error if:

• It doesn't run on Travis.
• The Github authentication token is missing.
• The Github authentication token is not authorized with Travis.
• It doesn't run on after_success step.

options

Type: Object

githubToken

Type: String Default: process.env.GH_TOKEN or process.env.GITHUB_TOKEN

GitHub OAuth token.

buildLeaderId

Type: Number Default: process.env.BUILD_LEADER_ID

Define which Travis job will run the script (build leader). If not defined the build leader will be the Travis job running on the highest Node version.

travisOpts

Type: Object

pro

Type: Boolean Default: false

true to use Travis Pro, false to use Travis for Open Source.

enterprise

Type: String Default: process.env.TRAVIS_URL

Travis Enterprise URL. If defined, the pro option will be ignored.

Note: This is the URL of the API endpoint, for example https://travis.example.com/api.