Skip to content

Commit 11de60e

Browse files
committed
feat(documentation): updare readme
1 parent 2c51d75 commit 11de60e

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,16 @@ danger(args) {
4747

4848
### Setup
4949

50-
#### macOS
50+
#### macOS (ARM)
5151
```sh
5252
brew install danger/tap/danger-kotlin
5353
```
5454

55+
#### macOS (Intel)
56+
```sh
57+
brew install danger/tap/danger-kotlin-intel
58+
```
59+
5560
You need to have Xcode installed and not relying on command line tools.
5661
If you're seeing this error when running xcodebuild:
5762

@@ -75,6 +80,12 @@ source ~/.bash_profile
7580
### GitHub Actions
7681
You can add danger/kotlin to your actions
7782

83+
Parameters:
84+
* `dangerfile`: Path to danger file, required: `false`, default: `Dangerfile.df.kts`
85+
* `run-mode`: Run mode: `ci`, `local`, `pr`, required: `false` default: `ci`
86+
* `job-id:` Reported CI job ID, required: `false`, default: `danger/kotlin`
87+
* `args`: Extra custom arguments like "--failOnErrors --no-publish-check" and etc, required: `false`
88+
7889
```yml
7990
jobs:
8091
build:
@@ -83,7 +94,7 @@ jobs:
8394
steps:
8495
- uses: actions/checkout@v1
8596
- name: Danger
86-
uses: danger/kotlin@1.2.0
97+
uses: danger/kotlin@1.3.0
8798
env:
8899
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
89100
```
@@ -101,9 +112,8 @@ jobs:
101112
steps:
102113
- uses: actions/checkout@v1
103114
- name: Danger
104-
uses: docker://ghcr.io/danger/danger-kotlin:1.2.0
105-
with:
106-
args: --failOnErrors --no-publish-check
115+
uses: docker://ghcr.io/danger/danger-kotlin:1.3.0
116+
run: danger-kotlin ci --failOnErrors --no-publish-check
107117
env:
108118
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
109119
```

0 commit comments

Comments
 (0)