What is the difference between deleteDir, cleanWs, and 'WsCleanup' in Jenkins pipeline?





.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty{ height:90px;width:728px;box-sizing:border-box;
}







5















These have all been mentioned (for example in this SO question) for cleaning up the workspace in Jenkinsfile.



Of these, deleteDir is the most commonly mentioned, and apparently the others are just different syntaxes for invoking the Jenkins Workspace Cleanup Plugin.



What is the functional difference? Which is recommended?



deleteDir()
cleanWs()
step([$class: 'WsCleanup'])









share|improve this question




















  • 3





    See stackoverflow.com/questions/37468455/…

    – user7294900
    Jan 3 at 9:09











  • Thank you. I added a link to that question (which was actually my trigger for asking my here.) That question mentions these, but does not state the difference between these options.

    – Joshua Fox
    Jan 3 at 9:20


















5















These have all been mentioned (for example in this SO question) for cleaning up the workspace in Jenkinsfile.



Of these, deleteDir is the most commonly mentioned, and apparently the others are just different syntaxes for invoking the Jenkins Workspace Cleanup Plugin.



What is the functional difference? Which is recommended?



deleteDir()
cleanWs()
step([$class: 'WsCleanup'])









share|improve this question




















  • 3





    See stackoverflow.com/questions/37468455/…

    – user7294900
    Jan 3 at 9:09











  • Thank you. I added a link to that question (which was actually my trigger for asking my here.) That question mentions these, but does not state the difference between these options.

    – Joshua Fox
    Jan 3 at 9:20














5












5








5








These have all been mentioned (for example in this SO question) for cleaning up the workspace in Jenkinsfile.



Of these, deleteDir is the most commonly mentioned, and apparently the others are just different syntaxes for invoking the Jenkins Workspace Cleanup Plugin.



What is the functional difference? Which is recommended?



deleteDir()
cleanWs()
step([$class: 'WsCleanup'])









share|improve this question
















These have all been mentioned (for example in this SO question) for cleaning up the workspace in Jenkinsfile.



Of these, deleteDir is the most commonly mentioned, and apparently the others are just different syntaxes for invoking the Jenkins Workspace Cleanup Plugin.



What is the functional difference? Which is recommended?



deleteDir()
cleanWs()
step([$class: 'WsCleanup'])






jenkins jenkins-plugins jenkins-pipeline






share|improve this question















share|improve this question













share|improve this question




share|improve this question








edited Feb 21 at 8:54







Joshua Fox

















asked Jan 3 at 9:03









Joshua FoxJoshua Fox

8,281115180




8,281115180








  • 3





    See stackoverflow.com/questions/37468455/…

    – user7294900
    Jan 3 at 9:09











  • Thank you. I added a link to that question (which was actually my trigger for asking my here.) That question mentions these, but does not state the difference between these options.

    – Joshua Fox
    Jan 3 at 9:20














  • 3





    See stackoverflow.com/questions/37468455/…

    – user7294900
    Jan 3 at 9:09











  • Thank you. I added a link to that question (which was actually my trigger for asking my here.) That question mentions these, but does not state the difference between these options.

    – Joshua Fox
    Jan 3 at 9:20








3




3





See stackoverflow.com/questions/37468455/…

– user7294900
Jan 3 at 9:09





See stackoverflow.com/questions/37468455/…

– user7294900
Jan 3 at 9:09













Thank you. I added a link to that question (which was actually my trigger for asking my here.) That question mentions these, but does not state the difference between these options.

– Joshua Fox
Jan 3 at 9:20





Thank you. I added a link to that question (which was actually my trigger for asking my here.) That question mentions these, but does not state the difference between these options.

– Joshua Fox
Jan 3 at 9:20












1 Answer
1






active

oldest

votes


















4














From official documentation:




deleteDir: Recursively delete the current directory from the workspace.
Recursively deletes the current directory and its contents. Symbolic links and junctions will not be followed but will be removed. To delete a specific directory of a workspace wrap the deleteDir step in a dir step.




So, deleteDir is a method of Workflow Basic Steps plugin (which is a component of Pipeline Plugin).




cleanWS: Delete workspace when build is done.




Seems to be that cleanWs() is just a new version of step([$class: 'WsCleanup']) from Workspace Cleanup Plugin.



So, as I understand, between deleteDir and cleanWs is a slightly difference: cleanWs has more options (like cleanWhenAborted, cleanWhenFailure, etc.) and it's more flexible to use, but it's recommended to use only when build is done (not sure if we can use it at the beginning of build execution). On the other side, we can use deleteDir step to wipe the workspace before build execution.






share|improve this answer


























    Your Answer






    StackExchange.ifUsing("editor", function () {
    StackExchange.using("externalEditor", function () {
    StackExchange.using("snippets", function () {
    StackExchange.snippets.init();
    });
    });
    }, "code-snippets");

    StackExchange.ready(function() {
    var channelOptions = {
    tags: "".split(" "),
    id: "1"
    };
    initTagRenderer("".split(" "), "".split(" "), channelOptions);

    StackExchange.using("externalEditor", function() {
    // Have to fire editor after snippets, if snippets enabled
    if (StackExchange.settings.snippets.snippetsEnabled) {
    StackExchange.using("snippets", function() {
    createEditor();
    });
    }
    else {
    createEditor();
    }
    });

    function createEditor() {
    StackExchange.prepareEditor({
    heartbeatType: 'answer',
    autoActivateHeartbeat: false,
    convertImagesToLinks: true,
    noModals: true,
    showLowRepImageUploadWarning: true,
    reputationToPostImages: 10,
    bindNavPrevention: true,
    postfix: "",
    imageUploader: {
    brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
    contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
    allowUrls: true
    },
    onDemand: true,
    discardSelector: ".discard-answer"
    ,immediatelyShowMarkdownHelp:true
    });


    }
    });














    draft saved

    draft discarded


















    StackExchange.ready(
    function () {
    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f54019121%2fwhat-is-the-difference-between-deletedir-cleanws-and-wscleanup-in-jenkins-pi%23new-answer', 'question_page');
    }
    );

    Post as a guest















    Required, but never shown

























    1 Answer
    1






    active

    oldest

    votes








    1 Answer
    1






    active

    oldest

    votes









    active

    oldest

    votes






    active

    oldest

    votes









    4














    From official documentation:




    deleteDir: Recursively delete the current directory from the workspace.
    Recursively deletes the current directory and its contents. Symbolic links and junctions will not be followed but will be removed. To delete a specific directory of a workspace wrap the deleteDir step in a dir step.




    So, deleteDir is a method of Workflow Basic Steps plugin (which is a component of Pipeline Plugin).




    cleanWS: Delete workspace when build is done.




    Seems to be that cleanWs() is just a new version of step([$class: 'WsCleanup']) from Workspace Cleanup Plugin.



    So, as I understand, between deleteDir and cleanWs is a slightly difference: cleanWs has more options (like cleanWhenAborted, cleanWhenFailure, etc.) and it's more flexible to use, but it's recommended to use only when build is done (not sure if we can use it at the beginning of build execution). On the other side, we can use deleteDir step to wipe the workspace before build execution.






    share|improve this answer






























      4














      From official documentation:




      deleteDir: Recursively delete the current directory from the workspace.
      Recursively deletes the current directory and its contents. Symbolic links and junctions will not be followed but will be removed. To delete a specific directory of a workspace wrap the deleteDir step in a dir step.




      So, deleteDir is a method of Workflow Basic Steps plugin (which is a component of Pipeline Plugin).




      cleanWS: Delete workspace when build is done.




      Seems to be that cleanWs() is just a new version of step([$class: 'WsCleanup']) from Workspace Cleanup Plugin.



      So, as I understand, between deleteDir and cleanWs is a slightly difference: cleanWs has more options (like cleanWhenAborted, cleanWhenFailure, etc.) and it's more flexible to use, but it's recommended to use only when build is done (not sure if we can use it at the beginning of build execution). On the other side, we can use deleteDir step to wipe the workspace before build execution.






      share|improve this answer




























        4












        4








        4







        From official documentation:




        deleteDir: Recursively delete the current directory from the workspace.
        Recursively deletes the current directory and its contents. Symbolic links and junctions will not be followed but will be removed. To delete a specific directory of a workspace wrap the deleteDir step in a dir step.




        So, deleteDir is a method of Workflow Basic Steps plugin (which is a component of Pipeline Plugin).




        cleanWS: Delete workspace when build is done.




        Seems to be that cleanWs() is just a new version of step([$class: 'WsCleanup']) from Workspace Cleanup Plugin.



        So, as I understand, between deleteDir and cleanWs is a slightly difference: cleanWs has more options (like cleanWhenAborted, cleanWhenFailure, etc.) and it's more flexible to use, but it's recommended to use only when build is done (not sure if we can use it at the beginning of build execution). On the other side, we can use deleteDir step to wipe the workspace before build execution.






        share|improve this answer















        From official documentation:




        deleteDir: Recursively delete the current directory from the workspace.
        Recursively deletes the current directory and its contents. Symbolic links and junctions will not be followed but will be removed. To delete a specific directory of a workspace wrap the deleteDir step in a dir step.




        So, deleteDir is a method of Workflow Basic Steps plugin (which is a component of Pipeline Plugin).




        cleanWS: Delete workspace when build is done.




        Seems to be that cleanWs() is just a new version of step([$class: 'WsCleanup']) from Workspace Cleanup Plugin.



        So, as I understand, between deleteDir and cleanWs is a slightly difference: cleanWs has more options (like cleanWhenAborted, cleanWhenFailure, etc.) and it's more flexible to use, but it's recommended to use only when build is done (not sure if we can use it at the beginning of build execution). On the other side, we can use deleteDir step to wipe the workspace before build execution.







        share|improve this answer














        share|improve this answer



        share|improve this answer








        edited Jan 21 at 12:29

























        answered Jan 3 at 10:28









        biruk1230biruk1230

        1,1441417




        1,1441417
































            draft saved

            draft discarded




















































            Thanks for contributing an answer to Stack Overflow!


            • Please be sure to answer the question. Provide details and share your research!

            But avoid



            • Asking for help, clarification, or responding to other answers.

            • Making statements based on opinion; back them up with references or personal experience.


            To learn more, see our tips on writing great answers.




            draft saved


            draft discarded














            StackExchange.ready(
            function () {
            StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f54019121%2fwhat-is-the-difference-between-deletedir-cleanws-and-wscleanup-in-jenkins-pi%23new-answer', 'question_page');
            }
            );

            Post as a guest















            Required, but never shown





















































            Required, but never shown














            Required, but never shown












            Required, but never shown







            Required, but never shown

































            Required, but never shown














            Required, but never shown












            Required, but never shown







            Required, but never shown







            Popular posts from this blog

            MongoDB - Not Authorized To Execute Command

            How to fix TextFormField cause rebuild widget in Flutter

            in spring boot 2.1 many test slices are not allowed anymore due to multiple @BootstrapWith