Clean workspace before building incrementals #141
Conversation
The incrementals build process will abort if `git status -s` is not empty. Since the maven step will invoke `mvn clean`, a `git clean` is safe.
|
@jenkins-infra/ci-maintainers Can we merge this? |
| @@ -66,6 +66,17 @@ def call(Map params = [:]) { | |||
| isMaven = fileExists('pom.xml') | |||
| incrementals = fileExists('.mvn/extensions.xml') && | |||
| readFile('.mvn/extensions.xml').contains('git-changelist-maven-extension') | |||
| if (incrementals) { // Incrementals needs 'git status -s' to be empty at start of job | |||
There was a problem hiding this comment.
Could we not just do this unconditionally?
There was a problem hiding this comment.
We certainly could, but I wanted to keep the impact of the change to only those specific cases where I know it is an issue. I'm willing to change the pull request to do it in all cases if that will help with its approval.
| if (isUnix()) { | ||
| sh(script: 'git clean -xffd || true', | ||
| label:'Clean for incrementals', | ||
| returnStatus: true) // Ignore failure if CLI git is not available |
There was a problem hiding this comment.
Does the || true not sufice?
There was a problem hiding this comment.
It should, but I was practicing an "abundance of caution" in hopes that a peripheral cleanup operation would have even less chance of inadvertently breaking a build.
There was a problem hiding this comment.
So then returnStatus: true should suffice (both both platforms)?
There was a problem hiding this comment.
Yes, should. Same "abundance of caution" logic. If ignoring the return value inside the script somehow did not work, also take the active measure of ignoring the return value from the step. Both sh and bat step documentation say:
Normally, a script which exits with a nonzero status code will cause the step to fail with an exception. If this option is checked, the return value of the step will instead be the status code.
There was a problem hiding this comment.
I've changed to hide the output from git clean and ignore the return code in c05194b . Let me know if other changes are needed (after the fix to change the Windows null device to the correct name nul instead of the incorrect name null)
No intention to do anything with the output if there is a failure. If the `git clean` command fails, then the `git status -s` command inside the maven incrementals build will likely also fail. Avoids distracting typical users reading the log file and wondering about output messages from `git clean`.
I tested them by running them on my home CI server. The CI tests at home (SCM API, Branch API, Git plugin, Git client plugin, Platform labeler plugin) detected the mistake that I had made in c05194b of using the wrong name for the nul device on Windows. That is corrected in 09edbc1. It was quite awkward to have a file named |
|
@jenkins-infra/ci-maintainers |
I had to resolve a conflict. I'm not sure that I chose the correct direction for the resolution of the conflict. We'll know when the tests run. |
Pro tip (cannot fathom why this is not the default): add to [merge]
conflictstyle = diff3 |
Once jenkins-infra/pipeline-library#141 is merged, the calls to `clean` can be removed.
|
I continue to encounter this problem in plugin builds that use incrementals. Is there anything else blocking it from being included in the pipeline shared library? @jenkins-infra/ci-maintainers is there anything that I need to do to have this merged? |
|
@MarkEWaite imo you should request to join that team, you’re doing work on ci.jenkins.io regularly |
Clean workspace before building incrementals
The incrementals build process will abort if
git status -sis not empty. Since the maven step will invokemvn clean, agit cleanis safe. In case command line git is not installed, the script does its very best to not fail with an error and to report that it intentionally did not fail with an error.Also includes a spelling fix.
This change is needed until ci.jenkins.io agents become 100% ephemeral. I've been hit repeatedly by tainted agent workspaces with the git plugin. This will reduce the failure rate of git plugin builds and git client plugin builds on ci.jenkins.io.
See my git plugin pull request for an example of this pull request being used in a repository.