README.md

Take Action

This is an action to assign yourself to an issue for a repo you are not a contributor to.

Usage

This GitHub Action lets a prospective contributor assign themselves to an issue, and optionally leaves a comment on the issue.

• message
  The message to display to the user once they have assigned themselves to an issue.
• blockingLabels
  A comma-separated list of labels that will prevent the action from running if they are present on the issue.
• blockingLabelsMessage
  The message to display to the user if the issue has a blocking label.
• trigger
  The string that take action will search for in the comment body to activate the action.

Setup

This GitHub Action can be optionally configured with a message to the prospective contributor.

The Action must be given a PAT with permission to write to Issues in the token input.

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.

To do this, follow the instructions in this doc: Managing GitHub Actions Permissions for your repository.

You can also configure message: below to be a custom message. Note that you cannot use words like it's or let's as the apostrophe messes with the syntax. You can use emojis, however you'll need to copy and paste the emoji directly like ❤️ instead of :heart: as the semi-colons ruin the syntax.

Example Workflow:

# .github/workflows/take.yml
name: Assign issue to contributor
on:
  issue_comment:

jobs:
  assign:
    name: Take an issue
    runs-on: ubuntu-latest
    permissions:
      issues: write
    steps:
    - name: take the issue
      uses: bdougie/take-action@main
      with:
        message: Thanks for taking this issue! Let us know if you have any questions!
        trigger: .take
        token: ${{ secrets.GITHUB_TOKEN }}