Experimental: Branch Restriction not working with 2 or more branch names

[kabua]

Configuration:

• Windows Server 2019
• Jenkins 2.440.1
• GitHub Integration Plugin 0.7.0

After a lot of work, we finally got this plugin working. Except when trying to whitelist two or more branches under the Experimental: Branch Restriction > Whitelist Target Restrictions section.

We have the following top-level protected branches: DEV, RELEASE, PROD, and HOTFIX.

In my test repo, I have PR from Features/100-testing merging into DEV.

If I set the WhiteList to DEV it works. If I set it to ABC, it fails - as expected.

BUT, if I try and use a multi-line, like so:

It fails, with this log entry:

Before searching the source code, I also tried using semi-colons (:), commas (,), and spaces ( ), which also failed.

I don't understand why Java's System.lineSeparator() doesn't recognize Jenkin's line separator.

public class GitHubPRBranchRestriction implements Describable<GitHubPRBranchRestriction> {
    private static final String LINE_SEPARATOR = System.lineSeparator();

Source file.

[KostyaSha]

what is written into xml config?

[KostyaSha]

According to code each line is used for Pattern compilation. You can try to put your rule into single line regexp.

[kabua]

@KostyaSha thanks for the quick reply.

what is written into xml config?

Where would I find this XML config file?

[kabua]

Using DEV|RELEASE worked!

@KostyaSha, thank you.

[KostyaSha]

Where would I find this XML config file?

on jenkins master in job's folder

[kabua]

We think we know what the bug is...

The log file shows this:

<branchRestriction>
        <targetBranchList>
          <string>DEV
RELEASE</string>
        </targetBranchList>

Using Note++, we verified that the file's line format is Unix (LF). But on Windows, we think that Java is returning \r\n thus.

private static List<String> split(String targetBranch) {
        return Arrays.asList(targetBranch.trim().split(LINE_SEPARATOR));
    }

can't split on \r\n because it only find \n.

Thus, LINE_SEPARATOR should be hard-coded to \n or split first on \r\n and then on \n.

[kabua]

To verify this idea, we converted the file to Windows (CR LF), then restarted the Jenkins service and tested again. But it still failed. 🤔

At least the regex idea works. 😃

[KostyaSha]

To verify this idea, we converted the file to Windows (CR LF), then restarted the Jenkins service and tested again. But it still failed. 🤔

the correct order may be shutdown, modify, start and verify. On shutdown it may save configs with in-memory data

[kabua]

It was a good idea, but it didn't work.

@KostyaSha - as it appears that this can't be fixed, should we close it out?

[kabua]

For those who also ran into this issue...

To recap the solution, the only viable way to whitelist multiple branches on a Windows machine is to use JAVA'S regex, like so:

DEV|MASTER|HOTFIX