Skip to content

Commit 376c71e

Browse files
Create checklist reference doc
1 parent d321b8b commit 376c71e

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<a name="module_checklist"></a>
2+
3+
## checklist
4+
Automatically check PRs against a checklist of conditions.
5+
This is useful if you want to ensure that PRs meet certain criteria before they can be merged.
6+
7+
**Returns**: <code>string</code> - Returns a formatted GitHub comment with a checklist of conditions that the PR meets.
8+
**License**: MIT
9+
10+
| Param | Type | Description |
11+
| --- | --- | --- |
12+
| Input | <code>string</code> | A blank string (no input variable is required) |
13+
| branch | <code>object</code> | The branch context variable. |
14+
| files | <code>object</code> | The files context variable. |
15+
| pr | <code>object</code> | The pr context variable. |
16+
| repo | <code>object</code> | The repo context variable. |
17+
| env | <code>object</code> | The env context variable. |
18+
| source | <code>object</code> | The source context variable. |
19+
20+
**Example**
21+
```js
22+
- action: add-comment@v1
23+
args:
24+
comment: {{ "" | checklist(branch, files, pr, repo, env, source) }}
25+
```

0 commit comments

Comments
 (0)