Skip to content

Commit 499e5e4

Browse files
committed
Update README
1 parent a56714d commit 499e5e4

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,30 @@
22

33
A GitHub action to create an issue using content from a file.
44

5-
This is useful to pair with other actions that output to a file. This action can create an issue if a file exists at a specified path.
5+
This is useful to pair with other actions that output to a file. This action will create an issue if a file exists at a specified path. If the file does not exist the action exits silently.
6+
7+
## Usage
8+
9+
```hcl
10+
action "Create Issue From File" {
11+
uses = "peter-evans/create-issue-from-file@v1.0.0"
12+
secrets = ["GITHUB_TOKEN"]
13+
env = {
14+
ISSUE_TITLE = "An example issue"
15+
ISSUE_CONTENT_FILEPATH = "./example-content/output.md"
16+
ISSUE_LABELS = "report, automated issue"
17+
ISSUE_ASSIGNEES = "peter-evans"
18+
}
19+
}
20+
```
21+
22+
#### Environment variables
23+
24+
- `ISSUE_TITLE` (**required**) - A title for the issue
25+
- `ISSUE_CONTENT_FILEPATH` (**required**) - The file path to the issue content
26+
- `ISSUE_LABELS` - A comma separated list of labels to apply
27+
- `ISSUE_ASSIGNEES` - A comma separated list of assignees
28+
29+
## License
30+
31+
MIT License - see the [LICENSE](LICENSE) file for details

0 commit comments

Comments
 (0)