Skip to content
This repository has been archived by the owner on Apr 18, 2023. It is now read-only.

Commit

Permalink
Update readme with details from 0.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Kurt Wagner committed Feb 14, 2017
1 parent 3d4e329 commit 991b6a6
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,32 @@ In JSON configuration file somewhere you safely control you can include your cre

At time of execution you consume the credentials file using the `--credentials` option.

Alternatively, you can pass the `--username` and `--password` but be aware that this may appear in your logs. Normally you will start your script with

```
set +x
```

so that commands you run are not echoed to the log.

### Message identifier

The message identifier is used to uniquely identify comments made by the user. Upon update, it will remove any previous comments before making new ones. You should manually set this if you plan to run multiple checkstyle files separately on a single pull request. e.g,

```
checkstyle --checkstyle perlcritic-checkstyle.xml \
--message-identifier ".:perl:." \
--credentials "/credentials.json" \
--pull-request 1000;
checkstyle --checkstyle eslint-checkstyle.xml \
--message-identifier ".:js:." \
--credentials "/credentials.json" \
--pull-request 1000;
```

It defaults to `.:.`.

### Quick Example

The following will make comments on pull request 1324 using errors from `checkstyle-result-1.xml` and `checkstyle-result-2.xml`.
Expand Down

0 comments on commit 991b6a6

Please sign in to comment.