naturalclar / issue-action

github action for github issue

Issue Action

Github action for automatically adding label or setting assignee when a new Issue or PR is opened.

Usage

Title or Body

Choose whether you want to check for a keyword match in the issue title, the issue body, or both.

Parameters

Automatically set BUG label and assign @username when Issue contains bug or error. Automatically set help-wanted label and assign @username when Issue contains help or guidance.

Example

name: "Set Issue Label and Assignee"
on:
  issues:
    types: [opened]
  pull_request:
    typed: [opened]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: Naturalclar/[email protected]
        with:
          title-or-body: "both"
          parameters: [ {"keywords": ["bug", "error"], "labels": ["BUG"], "assignees": ["username"]}, {"keywords": ["help", "guidance"], "labels": ["help-wanted"], "assignees": ["username"]}]
          github-token: "${{ secrets.GITHUB_TOKEN }}"

Upgrading this package

Follow the steps below:

# create a new release branch
$ git checkout -b release/vX.X.X

$ yarn build
$ git commit -a -m "release"
$ git push origin release/vX.X.X

issue-action's Issues

Feature request: check both issues and PRs

It would be great to be able to use this action to auto label and assign PRs as well as issues based on keywords.

I will try to put in a PR for this.

Node.js 12 actions are deprecated

Hi @Naturalclar

Our workflow got the following warning:

Node.js 12 actions are deprecated. Please update this action to use Node.js 16.
https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/

Hope u can address this because we are really liking the workflow over at https://github.com/FreeTubeApp/FreeTube/

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet.
We recommend using:

• CircleCI
• Travis CI
• Buildkite
• CodeShip
• Azure Pipelines
• TeamCity
• Buddy
• AppVeyor
  But Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

BUG: Action not working. error: index.js file not found

I'm trying to use the new 2.0.0 version and I keep getting this error:

File not found: '/home/runner/work/_actions/Naturalclar/issue-action/v2.0.0/lib/index.js'

Assign

assign automatically

Test Label

test label action

The `set-output` command is deprecated and will be disabled soon

Please upgrade to using Environment Files.

https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

bug/question: define multiline json string for `parameters`

Hi, I'm struggling to define parameters on multiple lines.

Why multiple lines? as our project is quite big we need lot of rules, which if defined inline became hard to read/maintain/bad DX

None of these works:

parameters: >
            '[
              {"keywords": ["projectA"], "labels": ["A"]},
              {"keywords": ["projectB"], "labels": ["B"]},
              {"keywords": ["projectC"], "labels": ["C"]}
            ]'

parameters: >
            '`[
              {"keywords": ["projectA"], "labels": ["A"]},
              {"keywords": ["projectB"], "labels": ["B"]},
              {"keywords": ["projectC"], "labels": ["C"]}
            ]`'

both will trigger JSON parse error

Do you have any suggestion how to achieve that ?

Thank you!

Feature Request: multiple keyword/label/assignee checks at once

Add ability to check for multiple keyword/label/assignee in one run by passing a json instead of having different fields.

Will submit a PR soon.

test

test

Feature Request: support addLabels, and removeLabels in labels option

This project is a great GitHub Action! Though when I was setting it up, I find it useful if it can let me define labels that I'd like to remove when certain keyword matches.

I've created #118 as a proof of concept, would like to see if this is something that's nice to have. Cheers!

test

test issue

Feature Request: assign/label based on keyword in title OR body

It would be great to add a field to select whether you want to match keywords in the title of the issue or the body or both.

In my case I need to only check the title.

I'll try to put in a PR for this.

Prepare for github publish

assign

assign test

Fix general test on pull request

Test fails on pull request, because it has Github token, but it does not have an issue.
assign

Assign Test

test

test

foo

bar

test

test issue

Feature Request: auto assign issue with project and milestone

Currently we can assign assignee and labels with keywords.
Can we do with project and milestone?

Thank you

foo

bar

Label

set label automatically

Fix typo in README.md

The typos in the example section of the README file are confusing as mentioned in #87 and #116.

Would be nice to fix up these typos to ease people setting up for using this tool.

Resource not accessible by integration - UnhandledPromiseRejectionWarning

@Naturalclar Got this error in a run from a PR. Is this because the PR was from an external branch?

UnhandledPromiseRejectionWarning: HttpError: Resource not accessible by integration
    at /home/runner/work/_actions/Naturalclar/issue-action/v2.0.2/lib/index.js:9506:23

https://github.com/spicetify/spicetify-themes/runs/5746767141?check_suite_focus=true

Label

Set label automatically if body contains label

Assign Test

Action fails when a keyword is set to an invalid regex expression

This commit made it so that keywords are treated as regular expressions, as opposed to literal strings before.

This resulted in our action failing with:

issue content: chore: fix unmatched parenthesis in issue-label-assign
Error: Invalid regular expression: /(?!-)\bevent-bridge)\b(?!-)/: Unmatched ')'

While its true we had missing parentheses in our configuration, i'm not sure this was the intended behavior, as the commit title seems to suggest it was just meant validate the keyword itself was surrounded with alphanumeric characters.

If it is meant as a regular expression, I suggest to add this to the documentation, and mention this is actually a breaking change. If not, the keyword needs to be properly escaped.

bug: Exception thrown if `assignees` is not defined

When some parameters property is not defined it will throw Exception as there is no array to iterate upon:

Example:

Fix:

Various:

• Following line needs to be handled in a defensive way so the program wont throw https://github.com/Naturalclar/issue-action/blob/master/src/setIssueAssignee.ts#L20
• Explicitly document that all fields are required

test

test

Test

Test

Feature Request: only check for keywords not surrounded by alpha characters

Here's an example of my use case: I'm parsing for the the keyword "CLI" but if someone has the word "clip" in their issue the action thinks there's a match when there shouldn't be. I want it to be able to pick up the keyword even if it's surrounded by non alpha characters though, like "(CLI)" should work and "CLI: asdhasd" should too.

Hoping this is useful for other people.

I have an almost complete fix. Will put in a PR shortly.

test

test

test

test