From 42e28f9e9ae833284b00fb49c82918e3c0f90807 Mon Sep 17 00:00:00 2001 From: Andy McKay Date: Fri, 20 Sep 2019 16:15:58 -0700 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0c3e88b4..7ad1dcdf 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ -Labels issues when they land in a repo with the `needs-triage` label. +Automatically labels issues, by adding new labels to the issue. You define the labels you'd like to add to your issues in the YAML file. -This is probably going to get a bit more sophisticated to meet all our needs but will do for the moment. \ No newline at end of file +To add it to your workflow: + +``` + - uses: andymckay/labeler@1.0.0 + with: + repo-token: "${{ secrets.GITHUB_TOKEN }}" + labels: "needs-triage, bug" +``` + +This adds the `needs-triage` and `bug` issues to the issue. The most common approach is to do this when issues are created, you can do this with the following in your workflow file: + +``` +on: + issues: + types: [opened] +``` + +That's it.