Skip to content

Latest commit

 

History

History
282 lines (201 loc) · 6.45 KB

ci.md

File metadata and controls

282 lines (201 loc) · 6.45 KB
Raw

heroku ci

run an application test suite on Heroku

heroku ci

display the most recent CI runs for the given pipeline

USAGE
  $ heroku ci [-a <value>] [--watch] [-p <value>] [--json]

FLAGS
  -a, --app=<value>       app name
  -p, --pipeline=<value>  name of pipeline
  --json                  output in json format
  --watch                 keep running and watch for new and update tests

DESCRIPTION
  display the most recent CI runs for the given pipeline

EXAMPLES
  $ heroku ci --app murmuring-headland-14719

See code: src/commands/ci/index.ts

heroku ci:config

display CI config vars

USAGE
  $ heroku ci:config [-s] [--json] [-p <value>] [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>       app to run command against
  -p, --pipeline=<value>  pipeline
  -r, --remote=<value>    git remote of app to use
  -s, --shell             output config vars in shell format
  --json                  output config vars in json format

DESCRIPTION
  display CI config vars
  Example:

  $ heroku ci:config --app murmuring-headland-14719 --json

heroku ci:config:get KEY

get a CI config var

USAGE
  $ heroku ci:config:get KEY [-s] [-p <value>] [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>       app to run command against
  -p, --pipeline=<value>  pipeline
  -r, --remote=<value>    git remote of app to use
  -s, --shell             output config var in shell format

DESCRIPTION
  get a CI config var
  Examples:

  $ heroku ci:config:get RAILS_ENV
  test

heroku ci:config:set

set CI config vars

USAGE
  $ heroku ci:config:set [-p <value>] [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>       app to run command against
  -p, --pipeline=<value>  pipeline
  -r, --remote=<value>    git remote of app to use

DESCRIPTION
  set CI config vars
  Examples:

  $ heroku ci:config:set RAILS_ENV=test
  Setting test config vars... done

  RAILS_ENV: test

heroku ci:config:unset

unset CI config vars

USAGE
  $ heroku ci:config:unset [-p <value>] [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>       app to run command against
  -p, --pipeline=<value>  pipeline
  -r, --remote=<value>    git remote of app to use

DESCRIPTION
  unset CI config vars
  Examples:

  $ heroku ci:config:uset RAILS_ENV
  Unsetting RAILS_ENV... done

heroku ci:debug

opens an interactive test debugging session with the contents of the current directory

USAGE
  $ heroku ci:debug [--no-setup] [-p <value>] [--no-cache] [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>       app to run command against
  -p, --pipeline=<value>  pipeline
  -r, --remote=<value>    git remote of app to use
  --no-cache              start test run with an empty cache
  --no-setup              start test dyno without running test-setup

DESCRIPTION
  opens an interactive test debugging session with the contents of the current directory
  Example:

  $ heroku ci:debug
  Preparing source... done
  Creating test run... done
  Running setup and attaching to test dyno...

  ~ $

heroku ci:info TEST-RUN

show the status of a specific test run

USAGE
  $ heroku ci:info TEST-RUN [-a <value>] [--node <value>] [-p <value>]

FLAGS
  -a, --app=<value>       app name
  -p, --pipeline=<value>  name of pipeline
  --node=<value>          the node number to show its setup and output

DESCRIPTION
  show the status of a specific test run

EXAMPLES
  $ heroku ci:info 1288 --app murmuring-headland-14719

See code: src/commands/ci/info.ts

heroku ci:last

looks for the most recent run and returns the output of that run

USAGE
  $ heroku ci:last [-a <value>] [--node <value>] [-p <value>]

FLAGS
  -a, --app=<value>       app name
  -p, --pipeline=<value>  name of pipeline
  --node=<value>          the node number to show its setup and output

DESCRIPTION
  looks for the most recent run and returns the output of that run

EXAMPLES
  $ heroku ci:last --pipeline=my-pipeline --node 100

See code: src/commands/ci/last.ts

heroku ci:migrate-manifest

app-ci.json is deprecated. Run this command to migrate to app.json with an environments key.

USAGE
  $ heroku ci:migrate-manifest

DESCRIPTION
  app-ci.json is deprecated. Run this command to migrate to app.json with an environments key.
  Example:

  $ heroku ci:migrate-manifest
  Writing app.json file... done
  Deleting app-ci.json file... done
  Please check the contents of your app.json before committing to your repo
  You're all set! 🎉.

heroku ci:open

open the Dashboard version of Heroku CI

USAGE
  $ heroku ci:open [-p <value>] [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>       app to run command against
  -p, --pipeline=<value>  pipeline
  -r, --remote=<value>    git remote of app to use

DESCRIPTION
  open the Dashboard version of Heroku CI
  opens a browser to view the Dashboard version of Heroku CI

  Example:

  $ heroku ci:open --app murmuring-headland-14719

heroku ci:rerun [NUMBER]

rerun tests against current directory

USAGE
  $ heroku ci:rerun [NUMBER] [-a <value>] [-p <value>]

FLAGS
  -a, --app=<value>       app name
  -p, --pipeline=<value>  name of pipeline

DESCRIPTION
  rerun tests against current directory

EXAMPLES
  $ heroku ci:rerun 985 --app murmuring-headland-14719

See code: src/commands/ci/rerun.ts

heroku ci:run

run tests against current directory

USAGE
  $ heroku ci:run [-a <value>] [-p <value>]

FLAGS
  -a, --app=<value>       app name
  -p, --pipeline=<value>  name of pipeline

DESCRIPTION
  run tests against current directory

EXAMPLES
  $ heroku ci:run --app murmuring-headland-14719

See code: src/commands/ci/run.ts