Skip to content

Commit

Permalink
docs: update readme to include args example
Browse files Browse the repository at this point in the history
  • Loading branch information
bryanoltman committed Apr 17, 2024
1 parent 4b50549 commit 1737eca
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Create a new release using the [Shorebird CLI](https://github.com/shorebirdtech/

## Usage

Standard usage:

```yaml
steps:
- uses: shorebirdtech/setup-shorebird@v0
Expand All @@ -28,6 +30,19 @@ steps:
shell: bash
```
If you need to provide arguments to the release command, you can do so like this:
```yaml
steps:
- uses: shorebirdtech/setup-shorebird@v0
- uses: shorebirdtech/shorebird-release@v0
id: shorebird-release
with:
args: --flutter-version=1.2.3 --verbose --flavor=my-flavor --target=lib/special_main.dart
platform: android
working-directory: ./path/to/app
```
## Inputs
The action takes the following inputs:
Expand Down

0 comments on commit 1737eca

Please sign in to comment.