Skip to content

Commit

Permalink
update README for new input parameter directory
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcoEidinger committed Feb 15, 2022
1 parent 13f600b commit 6b30f7f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,18 @@ By setting `isMutating` you declare the intention to update `Package.resolved` (

When setting `isMutating` the tool [SwiftPackageIndex/ReleaseNotes](https://github.com/SwiftPackageIndex/ReleaseNotes) is used to return release notes URLs for detected, necessary updates.

The GitHub action is looking in the current directory (`.`) for the package manifest but you can pass a different path with input parameter `directory`. Helpful for Monorepos where the `Package.swift` may not be at the root of the project.

```yaml
- name: Check Swift Package dependencies
id: spm-dep-check
uses: Sherlouk/swift-package-dependencies-check@main
with:
isMutating: true
failWhenOutdated: false
directory: 'Ingest'
```

A possible _workflow_ to periodically check for outdated dependencies and then create a pull request to update them:

```yaml
Expand Down

0 comments on commit 6b30f7f

Please # to comment.