Skip to content

Commit 59d4aaf

Browse files
committed
add docs for project attributes
1 parent f6665a4 commit 59d4aaf

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This is designed to be used in conjunction with other actions that output to a f
77
Especially if that output can be formatted as [GitHub flavoured Markdown](https://help.github.com/en/articles/basic-writing-and-formatting-syntax).
88
This action will create an issue if a file exists at a specified path.
99
The content of the issue will be taken from the file as-is.
10+
If project variables are specified, a card will be added to a project.
1011
If the file does not exist the action exits silently.
1112

1213
## Usage
@@ -19,6 +20,8 @@ If the file does not exist the action exits silently.
1920
ISSUE_TITLE: An example issue
2021
ISSUE_CONTENT_FILEPATH: ./example-content/output.md
2122
ISSUE_LABELS: report, automated issue
23+
PROJECT_NAME: Example Project
24+
PROJECT_COLUMN_NAME: To do
2225
```
2326
2427
#### Environment variables
@@ -27,6 +30,8 @@ If the file does not exist the action exits silently.
2730
- `ISSUE_CONTENT_FILEPATH` (**required**) - The file path to the issue content
2831
- `ISSUE_LABELS` - A comma separated list of labels to apply
2932
- `ISSUE_ASSIGNEES` - A comma separated list of assignees (GitHub usernames)
33+
- `PROJECT_NAME` - The name of a project to add a project card to (Requires `PROJECT_COLUMN_NAME`)
34+
- `PROJECT_COLUMN_NAME` - The name of the project column to add the card to
3035

3136
## Actions that pair with this action
3237

0 commit comments

Comments
 (0)