Skip to content

Commit 6fbefe3

Browse files
committed
update readme
1 parent a329b68 commit 6fbefe3

File tree

1 file changed

+52
-33
lines changed

1 file changed

+52
-33
lines changed

README.md

Lines changed: 52 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@ Implements a [GitHub
44
Action](https://help.github.com/en/categories/automating-your-workflow-with-github-actions)
55
that performs actions on issues and/or pull requests based on configurable conditions.
66

7-
At the moment it provides a single functionality to auto-label new issues and new pull requests.
7+
At the moment it provides the following actions
8+
- Labeler
9+
- Auto-label issues
10+
- Auto-label pull requests
11+
- Check issues for the existence of at least one label from a given list and auto-label if it's not found
12+
- Assigner
13+
- Auto-add issues to a project column - only repository projects are currently supported
814

915
## Installing
1016

@@ -21,7 +27,7 @@ contents:
2127
runs-on: ubuntu-latest
2228

2329
steps:
24-
- uses: ppapapetrou76/virtual-assistant@0.1
30+
- uses: ppapapetrou76/virtual-assistant@0.3
2531
env:
2632
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
2733

@@ -32,43 +38,56 @@ below.
3238

3339
Configuration can be stored at `./github/virtual-assistant.yml` as below
3440

35-
issues:
36-
labels:
37-
- label1
38-
- label2
39-
- area:label3
40-
at-least-one:
41-
labels:
42-
- priority:1
43-
- priority:2
44-
- priority:3
45-
default: priority:2
46-
pull-requests:
47-
labels:
48-
- label1
49-
- label2
50-
41+
The labeler action can be configured for issues and pull-requests.
42+
The `labels` property accepts a list of labels and these labels will be added to the issues/pull-requests
43+
The `actions` property accepts a list of event actions to trigger the labeler
44+
The `at-least-one` property accepts a list of labels and a default label.
5145

46+
The assigner action can be configured for issues
47+
The `project` property is composed of a `url` property which is the url of your project (just grab it from your browser)
48+
and a `column` property which is the name of your project column (case sensitive)
5249

53-
For example, given this `./github/virtual-assistant.yml`:
5450

51+
labeler:
5552
issues:
56-
labels:
57-
- label1
58-
- label2
59-
- area:label3
60-
at-least-one:
61-
labels:
62-
- priority:1
63-
- priority:2
64-
- priority:3
65-
default: priority:2
53+
labels:
54+
- label1
55+
- label2
56+
- area:label3
57+
actions:
58+
- opened
59+
- milestoned
60+
at-least-one:
61+
labels:
62+
- priority:1
63+
- priority:2
64+
- priority:3
65+
default: priority:2
66+
6667
pull-requests:
67-
labels:
68-
- label1
69-
- label2
68+
labels:
69+
- label1
70+
- label2
71+
actions:
72+
- opened
73+
- synchronize
74+
75+
assigner:
76+
issues:
77+
project:
78+
url: https://github.com/ppapapetrou76/virtual-assistant/projects/1
79+
column: To do
80+
actions:
81+
- opened
82+
- milestoned
83+
84+
85+
86+
87+
For example, given the above configuration
7088

7189
the action will
7290
- add to all new pull request the labels : `label1` and `label2`
7391
- add to all new issues the labels : `label1`,`label2` and `area:label3`
74-
- check all new issues if at least one of the labels `priority:1`,`priority:2`,`priority:3` exists and if not it will add the label `priority:2`
92+
- check all new issues if at least one of the labels `priority:1`,`priority:2`,`priority:3` exists and if not it will add the label `priority:2`
93+
- add all new issues to the project with number `1` under the column `To do`

0 commit comments

Comments
 (0)