From 86c7c495f296be06a192cd7590ab06d7012a3f73 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Mon, 26 Feb 2024 16:29:40 +0200 Subject: [PATCH] Add documentation for 'ignore_pr_titles' parameter in Usage.md --- Usage.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Usage.md b/Usage.md index c2f91bd0..bd4857e4 100644 --- a/Usage.md +++ b/Usage.md @@ -174,6 +174,13 @@ To cancel the automatic run of all the tools, set: handle_pr_actions = [] ``` +You can also disable automatic runs for PRs with specific titles, by setting the `ignore_pr_titles` parameter with the relevant regex. For example: +``` +[github_app] +ignore_pr_title = ["^[Auto]", ".*ignore.*"] +``` +will ignore PRs with titles that start with "Auto" or contain the word "ignore". + ##### GitHub app automatic tools for push actions (commits to an open PR) In addition to running automatic tools when a PR is opened, the GitHub app can also respond to new code that is pushed to an open PR.