Skip to content

Commit 186f170

Browse files
authored
Fill out usage
1 parent 6d6f098 commit 186f170

File tree

1 file changed

+45
-1
lines changed

1 file changed

+45
-1
lines changed

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,47 @@
11
# Remove Label from Cards
22

3-
Removes the given label from all cards in the given column.
3+
Removes one or more labels from all card issues in one or more columns of a project.
4+
5+
### columns_labels:
6+
A JSON Array of objects containing keys
7+
- `"labels"` An array of all the labels as strings
8+
Either
9+
- `"column_id"` The id of a column as an integer
10+
or
11+
- `"column_name"` The name of the column
12+
- `"project_name"` The name of the project containing the column
13+
14+
## Example Usage
15+
```
16+
on:
17+
schedule:
18+
- cron: '0 * * * *' # Run every hour
19+
20+
jobs:
21+
add_help_wanted_labels:
22+
runs-on: ubuntu-latest
23+
name: Remove labels based on column
24+
steps:
25+
- name: Remove labels based on column
26+
uses: rubyforgood/remove-label-from-cards@v2
27+
id: remove-help-wanted-labels
28+
with:
29+
token: ${{secrets.GITHUB_TOKEN}}
30+
columns_labels: >
31+
[
32+
{
33+
"column_name": "Done (in prod!)",
34+
"labels": ["Help Wanted"],
35+
"project_name": "Test"
36+
},
37+
{
38+
"column_name": "To Do",
39+
"labels": ["Help Wanted"],
40+
"project_name": "Test"
41+
},
42+
{
43+
"column_id": 16739169,
44+
"labels": ["Help Wanted"]
45+
},
46+
]
47+
```

0 commit comments

Comments
 (0)