Skip to content

Commit e0aaf13

Browse files
committed
docs(readme): document the base_sha and head_sha outputs
Documents the outputs which were added through #8.
1 parent b4a471d commit e0aaf13

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,26 @@ TODO: test also on `pull_request` events.
55

66
## Inputs
77

8-
## `token`
8+
### `token`
99
**Required:** Github API Token
1010

1111
## Outputs
1212

13-
## `base_ref`
13+
### `base_ref`
1414
Pull request base ref.
1515

16-
## `head_ref`
16+
### `base_sha`
17+
The SHA hash of the base ref.
18+
19+
### `head_ref`
1720
Pull request head ref.
1821

19-
## Example usage
22+
### `head_sha`
23+
The SHA hash of the head ref.
24+
25+
## Usage
26+
27+
### Example usage
2028
```
2129
- name: resolve pr refs
2230
id: refs
@@ -25,7 +33,7 @@ Pull request head ref.
2533
token: ${{ secrets.GITHUB_TOKEN }}
2634
```
2735

28-
## Example usecase
36+
### Example usecase
2937
```
3038
on:
3139
issue_comment:

0 commit comments

Comments
 (0)