Use core.autocrlf true for Windows line termination

[MarkEWaite]

Use LF as git end of line terminator on Windows

Windows virtual machines are currently configured to not use LF as their git end of line. That causes failures when spotless formats files on Windows that were originally created with Unix (LF) line termination.

This is a workaround until we update the Windows virtual machine definition to fix:

• jgit cloning not converting line ends on windows? helpdesk#3865

Testing done

I added the following text to the start of each Jenkinsfile in the test jobs and confirmed that job output contained the expected git commands on Windows agents and the test jobs passed with both useContainerAgent: true and useContainerAgent: false.

@Library('pipeline-library@set-autocrlf-on-windows') _

Plugins that were tested with both settings include:

• Built-on Column plugin PR-53 and master branch builds 63 and 64 - uses spotless
• Apache httpclient 4 API plugin builds 202 and 203 - uses spotless
• GitHub branch source plugin builds 484 and 485 - uses spotless
• JUnit plugin builds 443 and 444 - uses spotless
• Pipeline input step plugin builds 70 and 71 - does not use spotless
• Pipeline SCM step plugin builds 74 and 75 -does not use spotless
• Bitbucket branch source plugin 547 and 548 - does not use spotless

Plugins that were tested with only one setting (because they require a virtual machine to run their container based tests):

• SSH build agents plugin build 77 - does not use spotless
• Git client plugin build 1213 - uses spotless

[lemeurherveCB]

As you mentioned elsewhere, this PR should go along #898 as

plugins that use spotless will fail their builds on a Windows VM when they pass on a Windows container. Switch from container to VM makes that issue visible to more people.

Related:

• [Incident] Windows build of plugins don't start on ci.jenkins.io helpdesk#4490

[gounthar]

Thanks, Mark!

[MarkEWaite]

@lemeurherveCB suggested a technique that I can use to test this before it is merged. I'll do that testing before I merge it.

[jglick]

CC @jtnord

[jtnord]

the spotless issue is that it ends up just guessing that the line ending is native becasue there is no configuration otherwise.

The alternative (which uses windows line ends on windows, so is more like what windows would do) is to set git config --global core.autocrlf true

this should cause the files to have line ends changed on windows, and will be picked up by spotless to go "oh it is converting line ends, and I am on windows" so spotless does not end up guessing.

[MarkEWaite]

Thanks very, very much! Your guidance was exactly what I needed. I confirmed that core.autocrlf true resolves the spotless formatting issue and allows builds to be portable between ci.jenkins.io Windows containers and Windows virtual machines Setting core.eol lf does not resolve the issue.

[dduportal]

For info: jenkins-infra/packer-images#1649