1 | @heroku-cli/plugin-ci
|
2 | =====================
|
3 |
|
4 | Heroku CLI plugin for Heroku CI
|
5 |
|
6 | [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
|
7 | [![Version](https://img.shields.io/npm/v/@heroku-cli/plugin-ci.svg)](https://npmjs.org/package/@heroku-cli/plugin-ci)
|
8 |
|
9 | [![CircleCI](https://circleci.com/gh/heroku/cli/tree/master.svg?style=shield)](https://circleci.com/gh/heroku/cli/tree/master)
|
10 |
|
11 | [![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/heroku/cli?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/cli/branch/master)
|
12 | [![Codecov](https://codecov.io/gh/heroku/cli/branch/master/graph/badge.svg)](https://codecov.io/gh/heroku/cli)
|
13 | [![Downloads/week](https://img.shields.io/npm/dw/@heroku-cli/plugin-ci.svg)](https://npmjs.org/package/@heroku-cli/plugin-ci)
|
14 | [![License](https://img.shields.io/npm/l/@heroku-cli/plugin-ci.svg)](https://github.com/heroku/cli/blob/master/package.json)
|
15 |
|
16 |
|
17 | * [Usage](#usage)
|
18 | * [Commands](#commands)
|
19 |
|
20 | # Usage
|
21 |
|
22 | ```sh-session
|
23 | $ npm install -g @heroku-cli/plugin-ci
|
24 | $ heroku COMMAND
|
25 | running command...
|
26 | $ heroku (-v|--version|version)
|
27 | @heroku-cli/plugin-ci/7.12.4 darwin-x64 node-v10.9.0
|
28 | $ heroku --help [COMMAND]
|
29 | USAGE
|
30 | $ heroku COMMAND
|
31 | ...
|
32 | ```
|
33 |
|
34 | # Commands
|
35 |
|
36 | * [`heroku ci`](#heroku-ci)
|
37 | * [`heroku ci:info TEST-RUN`](#heroku-ciinfo-test-run)
|
38 | * [`heroku ci:last`](#heroku-cilast)
|
39 | * [`heroku ci:rerun [NUMBER]`](#heroku-cirerun-number)
|
40 | * [`heroku ci:run`](#heroku-cirun)
|
41 |
|
42 | ## `heroku ci`
|
43 |
|
44 | display the most recent CI runs for the given pipeline
|
45 |
|
46 | ```
|
47 | USAGE
|
48 | $ heroku ci
|
49 |
|
50 | OPTIONS
|
51 | -a, --app=app app to run command against
|
52 | -p, --pipeline=pipeline name of pipeline
|
53 | --watch keep running and watch for new and update tests
|
54 |
|
55 | EXAMPLE
|
56 | $ heroku ci --app murmuring-headland-14719
|
57 | ```
|
58 |
|
59 | _See code: [src/commands/ci/index.ts](https://github.com/heroku/cli/blob/v7.12.4/src/commands/ci/index.ts)_
|
60 |
|
61 | ## `heroku ci:info TEST-RUN`
|
62 |
|
63 | show the status of a specific test run
|
64 |
|
65 | ```
|
66 | USAGE
|
67 | $ heroku ci:info TEST-RUN
|
68 |
|
69 | OPTIONS
|
70 | -a, --app=app app to run command against
|
71 | -p, --pipeline=pipeline name of pipeline
|
72 | --node=node the node number to show its setup and output
|
73 |
|
74 | EXAMPLE
|
75 | $ heroku ci:info 1288 --app murmuring-headland-14719
|
76 | ```
|
77 |
|
78 | _See code: [src/commands/ci/info.ts](https://github.com/heroku/cli/blob/v7.12.4/src/commands/ci/info.ts)_
|
79 |
|
80 | ## `heroku ci:last`
|
81 |
|
82 | looks for the most recent run and returns the output of that run
|
83 |
|
84 | ```
|
85 | USAGE
|
86 | $ heroku ci:last
|
87 |
|
88 | OPTIONS
|
89 | -a, --app=app app to run command against
|
90 | -p, --pipeline=pipeline name of pipeline
|
91 | --node=node the node number to show its setup and output
|
92 |
|
93 | EXAMPLE
|
94 | $ heroku ci:last --app murmuring-headland-14719 --node 100
|
95 | ```
|
96 |
|
97 | _See code: [src/commands/ci/last.ts](https://github.com/heroku/cli/blob/v7.12.4/src/commands/ci/last.ts)_
|
98 |
|
99 | ## `heroku ci:rerun [NUMBER]`
|
100 |
|
101 | rerun tests against current directory
|
102 |
|
103 | ```
|
104 | USAGE
|
105 | $ heroku ci:rerun [NUMBER]
|
106 |
|
107 | OPTIONS
|
108 | -a, --app=app app to run command against
|
109 | -p, --pipeline=pipeline name of pipeline
|
110 |
|
111 | EXAMPLE
|
112 | $ heroku ci:rerun 985 --app murmuring-headland-14719
|
113 | ```
|
114 |
|
115 | _See code: [src/commands/ci/rerun.ts](https://github.com/heroku/cli/blob/v7.12.4/src/commands/ci/rerun.ts)_
|
116 |
|
117 | ## `heroku ci:run`
|
118 |
|
119 | run tests against current directory
|
120 |
|
121 | ```
|
122 | USAGE
|
123 | $ heroku ci:run
|
124 |
|
125 | OPTIONS
|
126 | -a, --app=app app to run command against
|
127 | -p, --pipeline=pipeline name of pipeline
|
128 |
|
129 | EXAMPLE
|
130 | $ heroku ci:run --app murmuring-headland-14719
|
131 | ```
|
132 |
|
133 | _See code: [src/commands/ci/run.ts](https://github.com/heroku/cli/blob/v7.12.4/src/commands/ci/run.ts)_
|
134 |
|
135 | * [`heroku ci:info`](#heroku-ci-info)
|
136 | * [`heroku ci:last`](#heroku-ci-last)
|
137 | * [`heroku ci:run`](#heroku-ci-run)
|
138 | * [`heroku ci:rerun`](#heroku-ci-rerun)
|
139 |
|
140 | ## `heroku ci:info`
|
141 |
|
142 | Shows the information for a particular ci run on a pipeline.
|
143 |
|
144 | ```
|
145 | USAGE
|
146 | $ heroku ci:info 555 --pipeline=my-pipeline # 555 is the test number
|
147 | ```
|
148 |
|
149 | ## `heroku ci:last`
|
150 |
|
151 | Shows the information for the last run for a given pipeline.
|
152 |
|
153 | ```
|
154 | USAGE
|
155 | $ heroku ci:last --pipeline=my-pipeline
|
156 | ```
|
157 |
|
158 | ## `heroku ci:run`
|
159 |
|
160 | Run this from within your repo directory to trigger a test agains the current branch and commit.
|
161 |
|
162 | ```
|
163 | USAGE
|
164 | $ heroku ci:run --pipeline=my-pipeline
|
165 | ```
|
166 |
|
167 | ## `heroku ci:rerun`
|
168 |
|
169 | Re-run a previous test run. If no test run number is provided, the most recent test run will be re-run.
|
170 |
|
171 | ```
|
172 | USAGE
|
173 | $ heroku ci:rerun 555 --pipeline=my-pipeline # 555 is the test number
|
174 | ```
|