Skip to content

Commit fe9c003

Browse files
authored
Update README.md
1 parent 4a73fb9 commit fe9c003

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Very simple, you provide the action with a `path` to a _file_ or _folder_, and i
1919
## Usage
2020
```yaml
2121
- name: Simple Diff
22-
uses: mudlabs/simple-diff@v1.1.0
22+
uses: mudlabs/simple-diff@v1.2.0
2323
with:
2424
path: path/to/file
2525
```
2626
2727
## Inputs
2828
| Input | Description | Default |
2929
| --- | :--- | --- |
30-
| `path` | Specifies a path from _root_ to the file or folder you want to check. | |
30+
| `path` | Specifies a path from the _root_ of your repository to the file or folder you want to check. If not provided the action will try to find a path specification from the workflow file itself. The path can be a `glob` string. | |
3131
| `strict` | Specifies the action should fail if the `path` is not in the commits diff tree. | `true` |
3232

3333
## Outputs
@@ -42,6 +42,7 @@ Very simple, you provide the action with a `path` to a _file_ or _folder_, and i
4242

4343
## Example Case
4444
You have a workflow that only runs on a push event to a file path. But you don't want it to run if the file was `removed` _(deleted)_.
45+
- _Note:_ In this example we do not specify the path property. If your workflow is conditioned to only run when changes to a given path occure, you don't need to provide the action with the file path. _(assuming that's the file path you want to check)_.
4546

4647
```yaml
4748
name: My File Workflow
@@ -57,10 +58,8 @@ jobs:
5758
steps:
5859
- uses: actions/checkout@v2
5960
- name: Simple Diff
61+
uses: mudlabs/simple-diff@v1.2.0
6062
id: diff
61-
uses: mudlabs/simple-diff@v1.1.0
62-
with:
63-
path: path/to/my/file.ext
6463
- run: exit 1
6564
if: steps.diff.outputs.removed == true
6665

0 commit comments

Comments
 (0)