Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-67643

Improve "disableDeferredWipeout" docs

    XMLWordPrintable

Details

    Description

      It could be just me but I'm having trouble understanding the docs for the `disableDeferredWipeout` property. It's not clear to me if I want deferred wipeout to be enabled or disabled (e.g. which is better), and if I do want it, then `disableDeferredWipeout` should be `false`, not `true`?

      Attachments

        Activity

          josh_m Josh McCullough created issue -
          surgery_jake Jake White added a comment -

          If possible, could this be expanded on. It doesn't appear that what the options do are documented anywhere.I haved checked: https://www.jenkins.io/doc/pipeline/steps/ws-cleanup/ ,  https://github.com/jenkinsci/ws-cleanup-plugin, and https://plugins.jenkins.io/ws-cleanup/#plugin-content-configuration

           

          I found the following options:

          • cleanWhenAborted : boolean (optional)
          • cleanWhenFailure : boolean (optional)
          • cleanWhenNotBuilt : boolean (optional)
          • cleanWhenSuccess : boolean (optional)
          • cleanWhenUnstable : boolean (optional)
          • cleanupMatrixParent : boolean (optional)
          • deleteDirs : boolean (optional)
          • disableDeferredWipeout : boolean (optional)
          • externalDelete : String (optional)
          • notFailBuild : boolean (optional)
          • patterns (optional){}{}
          • skipWhenFailed : boolean (optional)

          The only two that have any documentation are `patterns` and `disabledDeferredWipeout` the rest are guess work.

          surgery_jake Jake White added a comment - If possible, could this be expanded on. It doesn't appear that what the options do are documented anywhere.I haved checked: https://www.jenkins.io/doc/pipeline/steps/ws-cleanup/ ,  https://github.com/jenkinsci/ws-cleanup-plugin, and https://plugins.jenkins.io/ws-cleanup/#plugin-content-configuration   I found the following options: cleanWhenAborted : boolean (optional) cleanWhenFailure : boolean (optional) cleanWhenNotBuilt : boolean (optional) cleanWhenSuccess : boolean (optional) cleanWhenUnstable : boolean (optional) cleanupMatrixParent : boolean (optional) deleteDirs : boolean (optional) disableDeferredWipeout : boolean (optional) externalDelete : String (optional) notFailBuild : boolean (optional) patterns (optional) { }{ } skipWhenFailed : boolean (optional) The only two that have any documentation are `patterns` and `disabledDeferredWipeout` the rest are guess work.

          People

            olivergondza Oliver Gondža
            josh_m Josh McCullough
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: