Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Dids authored Oct 29, 2019
1 parent 3575c02 commit 234de56
Showing 1 changed file with 7 additions and 13 deletions.
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,17 @@

Provides [Swift](https://swift.org) support for [GitHub Actions](https://github.com/features/actions).

## Usage
## Inputs

To begin using this action, you only need to define `args` in the GitHub Action, which will be automatically forwarded to the `swift` binary (eg. `swift <args>`).
### `swift-action`

If you need more control over the process, you can define `runs` instead, which will override the `swift` binary (eg. `<runs> <args>`).
**Required** Swift action to run. Default `"build"`.

```hcl
workflow "main" {
on = "push"
resolves = ["swift_build"]
}
## Usage

action "swift_build" {
uses = "Didstopia/[email protected]"
args = "build"
}
```
uses: Didstopia/[email protected]
with:
swift-action: 'build'

To use the latest development version of this action, change the version number to `master` (eg. `Didstopia/SwiftAction@master`).

Expand Down

0 comments on commit 234de56

Please sign in to comment.