Skip to content

Commit 1c2544c

Browse files
committed
docs: clearer explanation for matrix build check
closes #65
1 parent 6c04896 commit 1c2544c

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/getting-started.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,9 @@ The complete script might look something like the below, but read on for the bre
5959
```bash
6060
#!/bin/bash
6161

62+
# NOTE: This step only required for matrix builds, see "Create a run-lhci script" for more details.
6263
if [[ "$TRAVIS_NODE_VERSION" != "10" ]]; then
63-
echo "Only run Lighthouse CI once per build, condititions did not match.";
64+
echo "Only run Lighthouse CI once per build, node version is not the selected version.";
6465
exit 0;
6566
fi
6667

@@ -99,7 +100,9 @@ addons:
99100
100101
### Create a run-lhci script
101102
102-
To contain all the steps necessary for Lighthouse CI, we'll create a file located at `scripts/run-lhci.sh` that should run as part of the build process. Make sure that this script is only run once per build or it will lead to confusing upload artifacts. For example, if you have a matrix build of several node versions, only run Lighthouse CI on one of them. In Travis, this translates to...
103+
To contain all the steps necessary for Lighthouse CI, we'll create a file located at `scripts/run-lhci.sh` that should run as part of the build process. In Travis, this translates to...
104+
105+
**NOTE:** Make sure that this script is only run once per build or it will lead to confusing upload artifacts. For example, if you have a matrix build of several node versions, only run Lighthouse CI on one of them.
103106

104107
**.travis.yml**
105108

@@ -115,9 +118,12 @@ script:
115118
```bash
116119
#!/bin/bash
117120
118-
# example if only running lighthouse on node 10
121+
# Example if your travis build runs a matrix like...
122+
# matrix:
123+
# - 12
124+
# - 10
119125
if [[ "$TRAVIS_NODE_VERSION" != "10" ]]; then
120-
echo "Only run Lighthouse CI once per build, condititions did not match.";
126+
echo "Only run Lighthouse CI once per build, node version is not the selected version.";
121127
exit 0;
122128
fi
123129

0 commit comments

Comments
 (0)