From e9009d60966b403dc777f8778e039c7362dfd823 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Fri, 20 Apr 2018 20:43:31 +0200 Subject: README: Add a note about branch name Redmine IDs Specify that Git branch names must be prefixed with a four-digit Redmine issue number. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 8be3fd8..9f1dd98 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,9 @@ executed with `bash -c`). A single argument is passed in `$0` containing the URL of the issue’s pull request. The format must match Redmine’s JSON parameter for the [issue update API endpoint][3]. +Pull request branches are assumed to start with a four-digit number followed by +a hyphen (e.g. `1234-`), where the number is a Redmine issue ID. + ## Install Requirements: -- cgit v1.2.3