Skip to content

Commit

Permalink
feat(documentation): updare readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Vacxe committed Mar 25, 2024
1 parent 2c51d75 commit 11de60e
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,16 @@ danger(args) {

### Setup

#### macOS
#### macOS (ARM)
```sh
brew install danger/tap/danger-kotlin
```

#### macOS (Intel)
```sh
brew install danger/tap/danger-kotlin-intel
```

You need to have Xcode installed and not relying on command line tools.
If you're seeing this error when running xcodebuild:

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

Parameters:
* `dangerfile`: Path to danger file, required: `false`, default: `Dangerfile.df.kts`
* `run-mode`: Run mode: `ci`, `local`, `pr`, required: `false` default: `ci`
* `job-id:` Reported CI job ID, required: `false`, default: `danger/kotlin`
* `args`: Extra custom arguments like "--failOnErrors --no-publish-check" and etc, required: `false`

```yml
jobs:
build:
Expand All @@ -83,7 +94,7 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Danger
uses: danger/kotlin@1.2.0
uses: danger/kotlin@1.3.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Expand All @@ -101,9 +112,8 @@ jobs:
steps:
- uses: actions/checkout@v1
- name: Danger
uses: docker://ghcr.io/danger/danger-kotlin:1.2.0
with:
args: --failOnErrors --no-publish-check
uses: docker://ghcr.io/danger/danger-kotlin:1.3.0
run: danger-kotlin ci --failOnErrors --no-publish-check

This comment has been minimized.

Copy link
@eygraber

eygraber Mar 25, 2024

Contributor

Not sure if this is still in progress, but the action fails if you specify uses and run in the same step.

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Expand Down

0 comments on commit 11de60e

Please sign in to comment.