Skip to content

Commit 7b31ddf

Browse files
authored
upd readme, rename
1 parent 69f9f88 commit 7b31ddf

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

readme.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,7 @@ Once you have generated a key, open the file that is downloaded and copy to text
6565
### 4. Set `GH_API` (enterprise only)
6666

6767
To get this package to work on github enterprise instances you will need to set the `GH_API` environment variable to a url pointing towards your enterprise GitHub's API.
68+
69+
### 5. (optional) Set `GH_CHECK_NAME`
70+
71+
If the default check name conflicts with something, you can override it by passing `GH_CHECK_NAME` environment variable.

src/create-check.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ export default async (results: eslint.CLIEngine.LintResult[]) => {
9090

9191
return createCheck({
9292
tool: 'ESLint',
93-
name: process.env.GITHUB_CHECK_NAME || 'Check Code for Errors',
93+
name: process.env.GH_CHECK_NAME || 'Check Code for Errors',
9494
annotations: createAnnotations(results),
9595
errorCount,
9696
warningCount,

0 commit comments

Comments
 (0)