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

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TeraNovaLP committed Jun 26, 2021
1 parent 4b048fc commit ee8205a
Showing 1 changed file with 1 addition and 17 deletions.
18 changes: 1 addition & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Code Reviewer
[![ci](https://github.com/Sokkuri/Code-Reviewer/workflows/CI/badge.svg)](https://github.com/Sokkuri/Code-Reviewer/commits/master)

Linter docker image
This action runs the in the project installed ESLint with the project specific config to check if the rules have been respected.

## How to use
### Github Action
Expand All @@ -13,18 +12,3 @@ jobs:
- uses: actions/checkout@vx.x.x
- uses: sokkuri/code-reviewer@vx.x.x
```
### GitLab CI
To use this as a step in **GitLab CI**, you can use this image like in [this configuration](https://gitlab.com/sokkuri/CI/-/blob/master/.gitlab/ci/linter.gitlab-ci.yml).
### Other
In other environments, you could use this command: `docker run --rm -e WORKSPACE=/lint -v /PATH_TO_FOLDER:/lint sokkuri/code-reviewer`

## Build image locally
To build this image locally there is the `buildDockerImage.ps1` script in the `build` folder.

## Used Linters
| Linter |
| ------------------------------------------------------------------------------------ |
| [Editorconfig Checker](https://github.com/editorconfig-checker/editorconfig-checker) |
| [Eslint](https://github.com/eslint/eslint) |

0 comments on commit ee8205a

Please sign in to comment.