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

Pipeline documentation missing archiveArtifact documentation

    XMLWordPrintable

Details

    Description

      When you go to http://jenkins_install/job/some_pipeline_job/pipeline-syntax/html or https://github.com/jenkinsci/pipeline-plugin/blob/master/TUTORIAL.md  you get a page documenting the DSL in Jenkinsfile.

      'archive' is listed as a deprecated step. Users are told to use 'archiveArtifacts' instead, but it's not actually documented anywhere on the page.

      Sorry if the component is wrong, it was hard to choose.

      Attachments

        Activity

          ssbarnea Sorin Sbarnea added a comment -

          Any updates on this? Finding anything related to pipelines seems to be a real struggle as writing and linking documentation seems to be an implied step in developing.

          ssbarnea Sorin Sbarnea added a comment - Any updates on this? Finding anything related to pipelines seems to be a real struggle as writing and linking documentation seems to be an implied step in developing.
          danielbeck Daniel Beck added a comment -

          This issue seems to be obsolete with Jenkins 2.60.2 and Pipeline: Groovy Plugin 2.39; the referenced page in Jenkins lists archiveArtifacts in the Steps section.

          danielbeck Daniel Beck added a comment - This issue seems to be obsolete with Jenkins 2.60.2 and Pipeline: Groovy Plugin 2.39; the referenced page in Jenkins lists archiveArtifacts in the Steps section.
          rtyler R. Tyler Croy added a comment -

          archiveArtifacts is listed yes, the archive setp is listed under "Advanced/Deprecated" (which is a hilarious section title, but that's another issue), and its helptext doesn't actually state that archive is deprecated.

          rtyler R. Tyler Croy added a comment - archiveArtifacts is listed yes, the archive setp is listed under "Advanced/Deprecated" (which is a hilarious section title, but that's another issue), and its helptext doesn't actually state that archive is deprecated.
          oleg_nenashev Oleg Nenashev added a comment -

          I am not sure why I was assigned to the ticket. It's probably an easy fix, so anybody can contribute

          oleg_nenashev Oleg Nenashev added a comment - I am not sure why I was assigned to the ticket. It's probably an easy fix, so anybody can contribute
          westonpace Weston Pace added a comment -

          In case someone else stumbles across this ticket, I don't know how to modify the docs but a quick scan of the [source](https://github.com/jenkinsci/jenkins/blob/f09d00dd32ea351105ef99456f3af1883d3ca8da/core/src/main/java/hudson/tasks/ArtifactArchiver.java) (as of 2017-09-26) reveals the following fields:

           

           * _artifacts_: comma or space separated list of patterns or files/directories to be archived (required)

           * _excludes_: Optional ant-style excludes pattern (default null)

           * _allowEmptyArchive_: If set the step will not fail, even if no artifacts are included.  (default false)

           * _fingerprint_: Generates a fingerprint (md5sum?  I'm not sure what this is.  I think it defaults to false)

           * _defaultExcludes_: No idea (defaults to true)

           * _caseSensitive_: Whether the artifacts patterns and excludes patterns should be case sensitive (defaults to true)

          westonpace Weston Pace added a comment - In case someone else stumbles across this ticket, I don't know how to modify the docs but a quick scan of the [source] ( https://github.com/jenkinsci/jenkins/blob/f09d00dd32ea351105ef99456f3af1883d3ca8da/core/src/main/java/hudson/tasks/ArtifactArchiver.java ) (as of 2017-09-26) reveals the following fields:    * _ artifacts _: comma or space separated list of patterns or files/directories to be archived (required)  * _ excludes _: Optional ant-style excludes pattern (default null)  * _ allowEmptyArchive _: If set the step will not fail, even if no artifacts are included.  (default false)  * _ fingerprint _: Generates a fingerprint (md5sum?  I'm not sure what this is.  I think it defaults to false)  * _ defaultExcludes _: No idea (defaults to true)  * _ caseSensitive _: Whether the artifacts patterns and excludes patterns should be case sensitive (defaults to true)

          People

            Unassigned Unassigned
            colemickens Cole Mickens
            Votes:
            4 Vote for this issue
            Watchers:
            8 Start watching this issue

            Dates

              Created:
              Updated: