| github_token | The GitHub token used to authenticate API requests. | yes | ${{ github.token }} |
| self_assign_cmd | The command that assigns the issue to the one who triggered it | — | /assign-me |
| self_unassign_cmd | The command that unassigns the issue from the user who triggered it, if they are already assigned. | — | /unassign-me |
| assign_user_cmd | The command that assigns the user to the issue | — | /assign |
| unassign_user_cmd | The command that unassigns the user from the issue, if they are assigned. | — | /unassign |
| maintainers | A list of maintainers authorized to use `/assign` and `/unassign` commands. List the usernames or team slugs (e.g., `@org/team-name`) comma-separated.
Note: To use team slugs, `github_token` must be a Personal Access Token (PAT) with `read:org` scope.
| yes | "" |
| enable_auto_suggestion | A boolean input that controls whether the action should automatically check user comments for phrases signaling interest in issue assignment. Set to true by default. | — | true |
| allow_self_assign_author | Whether to allow the issue author to self-assign their own issue. Set to 'false' to prevent users from creating issues and immediately assigning themselves. This gives maintainers control over which issues get worked on.
| — | true |
| assigned_label | The label applied to issues when they are assigned by this action to track assignments. | — | 📍 Assigned |
| required_label | If set, the issue must have this label in order for users to self-assign it. | no | "" |
| days_until_unassign | The number of days after assignment before the user is automatically unassigned (if the issue remains open). | — | 7 |
| pin_label | A label that prevents automatic unassignment, typically for long-term issues. | — | 📌 Pinned |
| assigned_text | The text posted after a returning contributor (has opened a PR before) has assigned themselves to an issue.
| — | ### 🎉 Issue Assignment Confirmation
Hey @{{ handle }}, thanks for taking on this issue!
> [!IMPORTANT]
> This issue will be automatically unassigned if idle for **{{ total_days }} days**.
<details>
<summary>ℹ️ Important information</summary>
- To prevent automatic unassignment, a maintainer can add the **{{{ pin_label }}}** label
- You can unassign yourself at any time by commenting with `/unassign-me`
- Updates and status reports are encouraged to show progress
</details>
|
| assigned_newcomer_text | The text posted after a first-time contributor (has never opened a PR) has assigned themselves to an issue. If not set, defaults to the `assigned_text` text.
| — | ### 🎉 Welcome to the Project!
Hey @{{ handle }}, thank you for your interest in this issue! 🎊
We're excited to have you on board. Start by exploring our [Contributing guidelines](CONTRIBUTING.md) and set up your local development workspace by following the steps in our documentation to get started smoothly.
> [!IMPORTANT]
> This issue will be automatically unassigned if idle for **{{ total_days }} days**.
<details>
<summary>ℹ️ Helpful resources for first-time contributors</summary>
- Check out the project's README for setup instructions
- Read through the codebase documentation if available
- Don't hesitate to ask questions here on GitHub
- Please open a (draft) pull request early to show the direction you're heading towards
</details>
<details>
<summary>📋 Assignment details</summary>
- To prevent automatic unassignment, a maintainer can add the **{{{ pin_label }}}** label
- You can unassign yourself at any time by commenting with `/unassign-me`
- Updates and status reports are encouraged to show progress
</details>
Happy coding! 🚀
|
| already_assigned_text | The text posted when a user tries to assign themselves to an issue that is already assigned.
| — | ### ⚠️ Issue Already Assigned
Hi @{{ handle }}, this issue is currently assigned to @{{ assignee }}.
> [!NOTE]
> If no progress is made within **{{ days_remaining }} days**, the issue will be automatically unassigned.
<details>
<summary>Options for contributors</summary>
- **Wait for availability**: The issue may become available if auto-unassigned
- **Collaborate**: You can ask the assignee if they want help
- **Maintainer assistance**: A maintainer can add you as co-assignee if appropriate
</details>
|
| already_assigned_pinned_text | The text posted when a user tries to assign themselves to a pinned issue that is already assigned.
| — | ### ⚠️ Issue Already Assigned
Hi @{{ handle }}, this issue is currently assigned to @{{ assignee }}.
> [!NOTE]
> This issue is pinned and will not be automatically unassigned.
<details>
<summary>Options for contributors</summary>
- **Collaborate**: You can ask the assignee if they want help
- **Maintainer assistance**: A maintainer can add you as co-assignee if appropriate
- **Wait for completion**: The issue will remain assigned until the work is complete
</details>
|
| unassigned_text | The text posted after a user is unassigned from an issue (by maintainer or due to inactivity).
| — | ### 📋 Assignment Update
Hi @{{ handle }}, you are no longer assigned to this issue.
<details open>
<summary>Next steps</summary>
**If you still want to work on this:**
- Comment with `/assign-me` to request reassignment
- Ask a maintainer to assign you again
- If you're making progress, a maintainer can add the **{{{ pin_label }}}** label to prevent future automatic unassignment
</details>
|
| self_unassigned_text | The text posted after a user unassigns themselves from an issue. If not set, defaults to the `unassigned_text` text.
| — | ### 📋 Self-Unassignment
Hi @{{ handle }}, you've unassigned yourself from this issue.
<details open>
<summary>Next steps</summary>
**If you change your mind:**
- Comment with `/assign-me` to reassign yourself
- Ask a maintainer to assign you again
</details>
|
| assignment_suggestion_text | The text posted when someone shows interest in being assigned to an issue without using the assignment commands.
| — | ### 👋 Interested in Contributing?
Hi @{{ handle }}, it looks like you're interested in working on this issue!
> [!TIP]
> Use the command `{{{ trigger }}}` to assign yourself to this issue.
Once assigned, you can start working on it right away. We appreciate your contribution!
|
| block_assignment | Whether to block self-assignment after unassignment | — | true |
| block_assignment_text | Text shown when blocked from self-assignment | — | ### ⚠️ Reassignment Blocked
Hi @{{ handle }}, you cannot assign yourself to this issue again.
> [!NOTE]
> Since you were previously unassigned from this issue, a maintainer needs to approve your reassignment.
Please ask a maintainer to assign you if you'd like to continue working on this issue.
|
| enable_reminder | Whether to send a reminder before unassignment | — | true |
| reminder_days | Number of days after assignment the reminder should be sent | — | auto |
| reminder_text | The text posted as a reminder before automatic unassignment occurs
| — | ### ⏰ Assignment Reminder
Hi @{{ handle }}, this is a friendly reminder about your assignment to this issue.
> [!WARNING]
> This issue will be **automatically unassigned** in **{{ days_remaining }} days** if there's no activity.
<details>
<summary>How to keep your assignment</summary>
You can prevent automatic unassignment by:
- Making progress on the issue (commenting, submitting PR)
- Asking for the **{{{ pin_label }}}** label if you need more time
- Letting maintainers know if you're still working on it
</details>
We appreciate your contribution and are here to help if needed!
|
| max_assignments | Maximum number of issues a user can be assigned to at once | no | 3 |
| max_assignments_text | Text to display when a user has reached their maximum assignments | no | ### ⚠️ Assignment Limit Reached
Hi @{{ handle }}, you've reached the maximum number of **{{ max_assignments }}** concurrent assignments.
> [!NOTE]
> Please complete or unassign from your current issues before taking on new ones.
<details>
<summary>Current options</summary>
- Complete one of your assigned issues and close it
- Use `/unassign-me` on an issue you're no longer working on
- Ask a maintainer for an exception if this is a special case
</details>
|
| max_overall_assignment_labels | A comma-separated list of labels which share a combined assignment limit. For example: `good first issue,good second issue`.
| no | good first issue,good second issue |
| max_overall_assignment_count | The maximum number of open (assigned) issues across the labels listed in `max_overall_assignment_labels` that a single user can hold at once.
| no | 2 |
| max_overall_assignment_text | Text shown when a user has reached the overall assignment limit | no | ### ⚠️ Assignment Limit Reached for Beginner Issues
Hi @{{ handle }}, you've already reached the limit of **{{ max_overall_assignment_count }}** active assignments across the labels:
`{{ max_overall_assignment_labels }}`.
These labels are meant for **new contributors** to get started, so we encourage you to now explore more advanced issues.
This helps new contributors take their first steps while you continue to grow with more challenging tasks 💪
---
**What you can do next:**
- ✅ Finish one of your current beginner-labeled issues, then come back for another.
- 🔄 Use `/unassign-me` on an issue you're no longer working on.
- 🚀 Ask a maintainer for suggestions on "next-level" issues (e.g. `good second issue` or beyond).
- 🙋 Request an exception from a maintainer if there's a special case.
> [!TIP]
> Moving to higher-level issues helps you deepen your skills and contribute more impactfully to the project.
Thanks for your great work and for helping keep the community open to newcomers! 💜
|
| self_assign_author_blocked_text | Text shown when the issue author tries to self-assign their own issue but it's not allowed | no | ### ⚠️ Self-Assignment Not Allowed
Hi @{{ handle }}, you cannot self-assign an issue you created.
> [!NOTE]
> This project requires maintainer approval before working on self-created issues to ensure alignment with the project roadmap.
<details>
<summary>What you can do</summary>
- Wait for a maintainer to review and approve your issue
- Ask a maintainer to assign you if the issue is approved
- Look for other existing issues to contribute to
</details>
|
| ignored_users | A comma-separated list of usernames that are ignored from using `/assign-me`. These users will not be able to self-assign issues.
| no | "" |
| ignored_text | Text shown when an ignored user tries to use `/assign-me` | no | ### ⚠️ Self-Assignment Not Allowed
Hi @{{ handle }}, you cannot self-assign issues. Please reach out to maintainers for the next steps.
|
| closed_issue_assignment_comment | Message shown when a user tries to assign themselves to a closed issue | no | ### ⚠️ Assignment Not Possible
Hi @{{ handle }}, you cannot assign yourself to a closed issue.
> [!NOTE]
> Assignment is only available for open issues.
<details>
<summary>What you can do</summary>
- Search for open issues in the repository
- Ask a maintainer if the issue should be reopened
- Look for similar open issues to contribute to
</details>
|