Skip to content

Commit

Permalink
Update document
Browse files Browse the repository at this point in the history
  • Loading branch information
yuichielectric committed Sep 26, 2020
1 parent 8da1150 commit f9396a7
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ dive action is an action that allows developers who develop Docker image to run

### Inputs

| Name | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------------------------------------ | ---------------------------------------------------------------------------- |
| image | String | true | | Image to analyze |
| config-file | String | false | `${{ github.workspace }}/.dive.yaml` | Path to [dive config file](https://github.com/wagoodman/dive#ci-integration) |
| Name | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------------------------------------ | ---------------------------------------------------------------------------- |
| image | String | true | | Image to analyze |
| config-file | String | false | `${{ github.workspace }}/.dive.yaml` | Path to [dive config file](https://github.com/wagoodman/dive#ci-integration) |
| github-token | String | false | | GitHub token to post PR comment on dive failure |

### Workflow

Expand All @@ -39,6 +40,7 @@ jobs:
with:
image: "sample:latest"
config-file: ${{ github.workspace }}/.dive-ci.yml
github-token: ${{ secrets.GITHUB_TOKEN }}
```
### Config file
Expand Down
3 changes: 3 additions & 0 deletions dist/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ async function run(): Promise<void> {
}

const token = core.getInput('github-token')
if (!token) {
return
}
const octokit = github.getOctokit(token)
const comment = {
...github.context.issue,
Expand Down

0 comments on commit f9396a7

Please sign in to comment.