Skip to content

Commit f000d65

Browse files
committed
Update docs
1 parent 7fe95d5 commit f000d65

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

readme.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Chat][chat-badge]][chat]
99

1010
[**unified**][unified] plugin to ignore unrelated messages.
11-
Currently works in PRs on Travis.
11+
Currently works in PRs on Travis and GitHub Actions.
1212

1313
When working with natural language, having tools that check cumbersome tasks
1414
can be very useful (think [alex][] or [retext][] plugins).
@@ -18,9 +18,9 @@ false positives.
1818
It’s possible to add a long list of exceptions, but this soon becomes
1919
unmanageable.
2020

21-
This plugin solves that problem, when in Travis, by ignoring any messages on
21+
This plugin solves that problem, when in CIs, by ignoring any messages on
2222
unchanged lines.
23-
When run outside Travis, this plugin doesn’t do anything.
23+
When run outside supported CIs this plugin doesn’t do anything.
2424

2525
## Install
2626

@@ -91,7 +91,9 @@ script:
9191
# ...
9292
```
9393

94-
When run in Travis, we’ll see the following printed on **stderr**(4).
94+
(or in an equivalent GH Actions workflow file)
95+
96+
When run in CI, we’ll see the following printed on **stderr**(4).
9597
Note that `an an` on L1 is not included because it’s unrelated to this PR.
9698

9799
```txt
@@ -102,7 +104,7 @@ readme.md
102104
⚠ 2 warnings
103105
```
104106

105-
As there are messages, the build exits with `1`, thus failing Travis.
107+
As there are messages, the build exits with `1`, thus failing CI.
106108
The user sees this and amends the PR to the following:
107109

108110
```diff
@@ -126,8 +128,9 @@ an error, but it’s unrelated to the PR.
126128
Ignore messages emitted by plugins before `diff` for lines that did not change.
127129

128130
There are no options.
129-
If there’s a `TRAVIS_COMMIT_RANGE` environment variable this plugin runs,
130-
otherwise it does nothing.
131+
If there’s a `TRAVIS_COMMIT_RANGE`, `GITHUB_BASE_REF` and `GITHUB_HEAD_REF`, or
132+
`GITHUB_SHA` environment variable, then this plugin runs, otherwise it does
133+
nothing.
131134

132135
###### TODO
133136

0 commit comments

Comments
 (0)