Skip to content

Commit

Permalink
Add example to the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
n-valchev committed Jul 22, 2024
1 parent 46085b3 commit bf0f46b
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Please refer to the [release page](https://github.com/fly-ci/wingman-action/rele

## Usage

Add `fly-ci/wingman-action` to your workflow job as the **last step**:

```yaml
- uses: fly-ci/wingman-action@main
if: failure()
Expand All @@ -42,6 +44,40 @@ permissions:
contents: read
```

### Example

```diff
name: CI
on:
pull_request:
jobs:
ci:
runs-on: flyci-macos-14-m2
+ permissions:
+ id-token: write
+ contents: read
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
- name: Install dependencies
run: npm install
- name: Run CI scripts
run: npm run ci
+ - uses: fly-ci/wingman-action@main
+ if: failure()
```

### Supported Runners

Currently, the action is compatible with both self-hosted and GitHub-hosted runners meeting the following criteria:
Expand Down

0 comments on commit bf0f46b

Please sign in to comment.