Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
givemesomefaces committed Jan 22, 2023
1 parent ceb4f28 commit 7117726
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A little tool to check dependencies by configuring a dependency blacklist.
You can use this tool in GitHub Actions, Gitlab CI or local machine.


### GitHub Actions
## GitHub Actions
Add `.dependency.yaml` file to the root directory of your project
```yaml
dependency:
Expand All @@ -27,7 +27,7 @@ and add the following to GHA `workflows`
#token: # optional: the token that dependency eye uses when it needs to comment on the pull request. Set to empty ("") to disable commenting on pull request. The default value is ${{ github.token }}
#mode: # optional: Which mode Dep-Eye should be run in. The default value is `check`.
```
### Gitlab CI
## Gitlab CI
First, dep-eye commands need to be configured in gitlab runner.
```yaml
dep-check-job: # job name.
Expand All @@ -39,29 +39,27 @@ dep-check-job: # job name.
- dep-eye d check
```
### Other
#### Download [release](https://github.com/lv-lifeng/eye/releases)
Download binary file `Assets/eye.zip`, and add `.dependency.yaml` file to the root directory of your project or the other specified directory(e.g. `/User/test.yaml`), and add the following.

Execute the following command in specified directory.
## Other
### Download [release](https://github.com/lv-lifeng/eye/releases)
Download binary file `Assets/eye.zip`, and add `.dependency.yaml` file to the root directory of your project or the other specified directory(e.g. `/User/other/dependency.yaml`), execute the following command in specified directory.
```shell
%PATH%/eye/bin/linux/dep-eye dependency(d/dep) -c /User/test.yaml check
%PATH%/eye/bin/linux/dep-eye dependency(d/dep) -c /User/other/dependency.yaml check
```
or add `%PATH%/eye/bin/linux` to the environment variable and execute the following command everywhere.
```shell
dep-eye dependency(d/dep) -c /User/test.yaml check
dep-eye dependency(d/dep) -c /User/other/dependency.yaml check
```
if the `-c` parameter is not specified and the current directory does not have `.dependency.yaml` file, then `dependency-default.yaml` will be used.

#### Compile from source
### Compile from source
```shell
git clone git@github.com:lv-lifeng/eye.git
cd eye
make build
```
the command same as [download release](#download-releasehttpsgithubcomlv-lifengeyereleases)

### Check result
## Check result
```shell
dep-eye d check
INFO Loading configuration from file: .dependency.yaml
Expand Down

0 comments on commit 7117726

Please sign in to comment.