Use CircleCI version 2.1 at the top of your .circleci/config.yml file.
1
version: 2.1
Add the orbs
stanza below your version, invoking the orb:
1
2
orbs:
happo: happo/happo@2.0.1
Use happo
elements in your existing workflows and jobs.
Opt-in to use of uncertified orbs on your organization’s Security settings page.
Use the provided `happo/run_happo` command in a custom job.
1
2
3
4
5
6
7
8
9
10
11
version: 2.1
orbs:
happo: happo/happo@latest
jobs:
happo:
docker:
- image: <a node docker image>
steps:
- checkout
- npm install
- happo/run_happo
Use the provided `happo/run` job directly.
1
2
3
4
5
6
7
8
version: 2.1
orbs:
happo: happo/happo@latest
workflows:
version: 2.1
run_all:
jobs:
- happo/run
Install package dependencies via yarn or npm (auto-detects).
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# This code is licensed from CircleCI to the user under the MIT license.
# See here for details: https://circleci.com/developer/orbs/licensing
version: 2.1
description: |
Run screenshot tests via happo.io in your project. API tokens are read from
$HAPPO_API_KEY and $HAPPO_API_SECRET, or directly from `apiKey` and `apiToken`
if you have them listed in your `.happo.js` config.
display:
source_url: https://github.com/happo/happo-circleci-orb
home_url: https://happo.io/
commands:
run_happo:
description: |
Run Happo in the current directory.
steps:
- run:
name: Run Happo
command: |
if [ -f 'yarn.lock' ]; then
yarn happo-ci-circleci
else
npm run happo-ci-circleci
fi
install_dependencies:
description: |
Install package dependencies via yarn or npm (auto-detects).
steps:
- run:
name: Install dependencies
command: |
if [ -f 'yarn.lock' ]; then
yarn install --pure-lockfile
else
npm install --no-save
fi
jobs:
run:
description: |
Check out code, install dependencies, then run Happo.
docker:
- image: circleci/node:10
steps:
- checkout
- install_dependencies
- run_happo
examples:
run_happo_command:
description: |
Use the provided `happo/run_happo` command in a custom job.
usage:
version: 2.1
orbs:
happo: happo/happo@latest
jobs:
happo:
docker:
- image: <a node docker image>
steps:
- checkout
- npm install
- happo/run_happo
use_happo_job:
description: |
Use the provided `happo/run` job directly.
usage:
version: 2.1
orbs:
happo: happo/happo@latest
workflows:
version: 2.1
run_all:
jobs:
- happo/run