This action allows the usage of some commands from the organization to moderate the issues of a repository. It can also search for duplicate URLs in the opened issues and close the new opened issue if needed.
To configure the action simply add the following lines to your workflow file:
name: Moderator
on:
issues:
types:
# If you want the duplicate URL checker and/or the auto-closer
- opened
# If you want the auto-closer to run
- edited
- reopened
issue_comment:
types: [created]
jobs:
moderate:
runs-on: ubuntu-latest
steps:
- name: Moderate issues
uses: tachiyomiorg/issue-moderator-action@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}| Name | Description | Default value |
|---|---|---|
repo-token |
GitHub token | |
duplicate-command |
Optional duplicate command text. | Duplicate of # |
edit-title-command |
Optional edit issue title command text. | Edit title to |
lock-command |
Optional lock command text. | Lock this issue |
duplicate-check-enabled |
Enable the duplicate URL finder if sets to true. |
|
duplicate-check-label |
Label of the opened issues to check. | |
auto-close-rules |
A JSON-compliant string containing a list of rules, where a rule consists of the content below. | |
auto-close-ignore-label |
Optional label name. If present, auto-close rule execution is skipped. |
All commands can be used in more bot-like way, that supports ?, !
and / as the invocation character, and alternatively with a more
human readable way, with sentences that can be customized.
The comment with the command will be minimized and marked as resolved.
This command will close the current issue as an duplicate.
Usage:
- Bot-like:
?duplicate #<issue-number> - Sentence:
Duplicate of #<issue-number>
If the sentence way is used and the comment contains a question mark after the issue number, the command will not be executed as a way to preventing the current issue from being closed if the person that commented are in doubt if the current issue is indeed a duplicate.
This command will edit the title of the current issue. The new title
must be surrounded by double quotes, and it supports escaping by using \".
Usage:
- Bot-like:
?edit-title "<new-title>" - Sentence:
Edit title to "<new-title>"
This command will lock the current issue.
Usage:
- Bot-like:
?lock - Sentence:
Lock this issue
Alternatively, the lock reason can be specified.
Usage:
- Bot-like:
?lock <off-topic|too heated|resolved|spam> - Sentence:
Lock this issue as <off-topic|too heated|resolved|spam>
The action can also check for opened issues with a given label for duplicate URLs. It's useful if you have a system to request websites to be added to your repository through issues.
To enable it, you need to set duplicate-check-enabled to true
and define the label that the action should check with duplicate-check-label.
Automatically close issues whose title or body text matches the specified regular expression pattern.
Rules are re-evaluated on issue edits and automatically reopens the issue if the rules pass.
{
type: 'title' | 'body' | 'both';
regex: string;
message: string;
ignoreCase: boolean | undefined;
}type: Part to run regex against.regex: String compiled to a JavaScriptRegExp. If matched, the issue is closed.message: ES2015-style template literal evaluated with the issue webhook payload in context (see payload example). Posted when the issue is closed. You can use{match}as a placeholder to the first match.ignoreCase: Optionally make the regex case insensitive. Defaults tofalse.
Example:
auto-close-rules: |
[
{
"type": "title",
"regex": ".*Placeholder title.*",
"message": "@${issue.user.login} this issue was automatically closed because it did not follow the issue template"
}
]