Skip to content

Commit e351acc

Browse files
committed
fix: correct README simple example to not require labels for non-pinned use
The simple usage example included `pinned: true` without `labels`, which causes "Error: Invalid inputs" for anyone copying it verbatim. Pinning requires labels to find the previous issue to unpin. Split into a plain example and a separate pinning example with the required `labels` field. Closes #104
1 parent 3566ae2 commit e351acc

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,20 @@ Simple example:
5050
title: Hello, world
5151
body: |-
5252
:wave: Hi, {{#each assignees}}@{{this}}{{#unless @last}}, {{/unless}}{{/each}}!
53+
# ...
54+
```
55+
56+
Example with pinning (note: `pinned` requires `labels`):
57+
```yml
58+
# ...
59+
- name: Create new issue
60+
uses: imjohnbo/issue-bot@v3
61+
with:
62+
assignees: "octocat, monalisa"
63+
labels: "standup"
64+
title: Hello, world
65+
body: |-
66+
:wave: Hi, {{#each assignees}}@{{this}}{{#unless @last}}, {{/unless}}{{/each}}!
5367
pinned: true
5468
# ...
5569
```

0 commit comments

Comments
 (0)