1 | # Heroku CI CLI
|
2 | [![Heroku CI Status](https://ci-badges.herokuapp.com/pipelines/420ca0bc-031b-479a-9335-1d51046daab2/master.svg)](https://dashboard.heroku.com/pipelines/420ca0bc-031b-479a-9335-1d51046daab2/tests)
|
3 |
|
4 | The CLI plugin for Heroku CI
|
5 |
|
6 | ## Installation
|
7 |
|
8 | This plugin is part of the official Heroku CLI, so there is no need to install it to run their commands.
|
9 |
|
10 | ## Development
|
11 |
|
12 | First, please read [Developing CLI Plugins on Heroku's DevCenter](https://devcenter.heroku.com/articles/developing-toolbelt-plug-ins).
|
13 |
|
14 | ### Run Tests
|
15 |
|
16 | ```
|
17 | $ npm test
|
18 | ```
|
19 |
|
20 | ### Deploy
|
21 |
|
22 | 1. Release a new version of this npm package. e.g. Using [`np`](https://www.npmjs.com/package/np)
|
23 |
|
24 | ```
|
25 | › np
|
26 |
|
27 | Publish a new version of heroku-ci (1.6.0)
|
28 |
|
29 | ? Select semver increment or specify new version minor 1.7.0
|
30 | ? Will bump from 1.6.0 to 1.7.0. Continue? Yes
|
31 | ✔ Prerequisite check
|
32 | ✔ Git
|
33 | ✔ Cleanup
|
34 | ✔ Installing dependencies using Yarn
|
35 | ✔ Running tests
|
36 | ✔ Bumping version using Yarn
|
37 | ✔ Publishing package
|
38 | ✔ Pushing tags
|
39 |
|
40 | heroku-ci 1.7.0 published 🎉
|
41 | ```
|
42 |
|
43 | 2. Open a new pr in https://github.com/heroku/cli/blob/master/package.json, updating to the appropriate heroku-ci version.
|
44 |
|
45 | ## Commands
|
46 |
|
47 | All commands accept a `-a` flag. This should be the name of an app in the pipeline you have connected to Heroku CI. The `-a` flag can be omitted if you are in the directory of an app already.
|
48 |
|
49 | `heroku ci:list`, aliased as `heroku ci`
|
50 |
|
51 | Show the statuses of the most recent test runs. Add the `-w` or `--watch` flag to keep the session running and listen for updates.
|
52 |
|
53 | `heroku ci:info NUMBER`
|
54 |
|
55 | Show the status of a specific test run. If no run number is provided the most recent will be shown.
|
56 |
|
57 | `heroku ci:last`
|
58 |
|
59 | Show the status of the most recent test run
|
60 |
|
61 | `heroku ci:run`
|
62 |
|
63 | Run this from within your repo directory to trigger a test agains the current branch and commit.
|
64 |
|
65 | `heroku ci:rerun NUMBER`
|
66 |
|
67 | Re-run a previous test run. If no test run number is provided, the most recent test run will be re-run.
|
68 |
|
69 | `heroku ci:migrate-manifest`
|
70 |
|
71 | Migrate the current directory from the deprecated `app-ci.json` file format to the new `app.json` + `environments`. [See the docs](https://devcenter.heroku.com/articles/heroku-ci-prerelease#migrating-applications-using-app-ci-json) for more details.
|
72 |
|
73 | `heroku ci:debug`
|
74 |
|
75 | Run this from within your repo directory to start and attach to a debug run. Useful for debugging failing test setup or a test which fails in CI but passes locally.
|