feat: add support for blocking labels

[nickytonline]

Adds support for blocking labels. Adding blocking labels is optional, so the GitHub action works as it did previously if no blocking labels are configured.

Existing scenarios:

• There are no blocking labels on an issue:

  • The user can be assigned the issue assuming it isn't already assigned. See https://github.com/nickytonline/test-take-action/actions/runs/6566343428/job/17837978699

  • The user cannot be assigned the issue if someone is already assigned. See https://github.com/nickytonline/test-take-action/actions/runs/6566879299/job/17838484505

• There is a blocking label on an issue:

  • The user cannot be assigned. See https://github.com/nickytonline/test-take-action/actions/runs/6566973419/job/17838795429

• There is more than one blocking label on an issue:

  • The user cannot be assigned. See https://github.com/nickytonline/test-take-action/actions/runs/6566887793/job/17838515063

Sample workflow for this workflow in a repository with blocking labels enabled

name: "Assign issues with .take"

on:
  issue_comment:
    types:
      - created
      - edited

jobs:
  take-issue:
    name: Disable take issue
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: take an issue
        uses: bdougie/take-action@main
        with:
          issueCurrentlyAssignedMessage: Thanks for being interested in this issue. It looks like this ticket is already assigned to a contributor.
          token: ${{ secrets.GITHUB_TOKEN }}
+          blockingLabels: needs triage,blocked

I'm pretty sure this is unrelated as I didn't change anything for how the GitHub API calls work, but I think I have the action misconfigured as I get this error when trying to use the API. Not sure why it's not finding my secrets.GITHUB_TOKEN

"message": "Resource not accessible by integration",

Closes #20

[nickytonline]

Looks like prettier cleaned up some trailing white space

[nickytonline]

This is ready for review @bdougie @brandonroberts @jpmcb

[nickytonline]

Gets the issue labels as an array.

[nickytonline]

By default, no blocking labels

[nickytonline]

A default message about blocking labels that can be customized.

[bdougie]

@nickytonline are you still getting the

"message": "Resource not accessible by integration"?

I know silently changes what permissions the default token has. Curious if labels are included or another feature is not accessible from the default token.

[nickytonline]

@nickytonline are you still getting the

"message": "Resource not accessible by integration"?

I know silently changes what permissions the default token has. Curious if labels are included or another feature is not accessible from the default token.

The permission error isn't related to the issue labels. Those I can read fine. I get that error when trying to add a comment or assign a user. That's why I think it's unrelated to my changes. I could be wrong though. 😅

[jpmcb]

This lgtm.

I think I discovered your token permission problem. I created my own test repo: https://github.com/jpmcb/test-take but I was also getting permission errors (on both nickytonline/take-action and bdougie/take-action

But once I updated this Actions setting:

it started working as expected. It seems the default workflow permission for GITHUB_TOKEN is read only.

[jpmcb]

The easiest way is to use the built-in ${{ secrets.GITHUB_TOKEN }} for authentication (as per the example below), but you'll need to ensure you've appropriately set the permissions for the GitHub Token so that your workflow can update Issues.

Looks like this is documented in the README 😓 😅 https://github.com/bdougie/take-action?tab=readme-ov-file#setup

I totally breezed by that when investigating the token issue ha.

[bdougie]

Looks like this is documented in the README 😓 😅 https://github.com/bdougie/take-action?tab=readme-ov-file#setup

I totally breezed by that when investigating the token issue ha.

That's it. Permissions need to verify set now.

[nickytonline]

Looks like this is documented in the README 😓 😅 https://github.com/bdougie/take-action?tab=readme-ov-file#setup

I totally breezed by that when investigating the token issue ha.

That's it. Permissions need to verify set now.

@bdougie, I updated the permissions for actions on my test repo and all good now, e.g. https://github.com/nickytonline/test-take-action/actions/runs/6567914467

And here’s an automated comment telling me it’s blocked by a label, nickytonline/test-take-action#3 (comment).

[bdougie]

This looks great. Look forward to adding this version to our projects.