The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Inedo ProGet Plugin.

downloadProgetPackage: ProGet Package Download

Downloads a universal ProGet package to specified folder and will optionally unpack it for you.

Download options are:

  • Package - Download ProGet universal package (ZIP file with extension of 'unpack')
  • Content as ZIP - Download content as ZIP file
  • Content as TGZ - Download content as TGZ file
  • Unpack Content - Extract the package content once downloaded
In all cases except 'Unpack Content' the environment variable PROGET_FILE will be populated with the name of the downloaded file

See Inedo documentation.

  • feedName
    • Type: String
  • groupName
    • Type: String
  • packageName
    • Type: String
  • version
    • Type: String
  • downloadFormat
    • Type: String
  • downloadFolder
    The folder to download the package to. The path can include environment variables in the format ${VAR} or $VAR.

    If a full pathname is not supplied then the downloaded package 'should' end up in the workspace, but this is not guaranteed. If you wish the package to be placed in the workspace the it is best to use the Jenkins variable ${WORKSPACE}

    See the list of available environment variables.

    • Type: String

uploadProgetPackage: ProGet Package Upload

Creates and uploads a universal ProGet package to your ProGet server.
  • feedName
    The feed in ProGet to upload the package to
    • Type: String
  • groupName
    The package you wish to upload your package to.

    A string of no more than fifty characters:

    • numbers (0-9)
    • upper and lower-case letters (a-Z)
    • dashes (-)
    • periods (.)
    • forward-slashes (/)
    • and underscores (_)
    • may not start or end with a forward-slash
    e.g. an/example/group

    • Type: String
  • packageName
    The package you wish to upload your package to.

    A string of no more than fifty characters:

    • numbers (0-9)
    • upper and lower-case letters (a-Z)
    • dashes (-)
    • periods (.)
    • and underscores (_)
    e.g. mypackage

    • Type: String
  • version
    A string representing a Semantic Version; this is a three-part, dot- specification

    e.g. 1.0.0

    • Type: String
  • artifacts
    You can use wildcards like 'module/dist/**/*.zip'. See [the includes attribute of Ant fileset](http://ant.apache.org/manual/Types/fileset.html) for the exact format.
    • Multiple patterns can be specified by placing a comma (,) between them
    • The base directory is the workspace. You can only archive files that are located in your workspace
    • Will fail the build if no files are found

    Removing Unwanted Folders
    Top level folders can be excluded from the package using a custom addition to the Ant fileset - wrapping unwanted folder names in square brackets ([ ]):

    • filter must start with '['
    • wildcards are not supported
    • filter can span a several folders
    • invalid filters are ignored
    • can be used with multiple filesets
    Examples:
    • "[build]/sample/one.txt" would add the folder and file "sample/one.txt" to the package
    • "[build/sample]/two.txt" would add the file "one.txt" to the package
    • "build/[sample]/three.txt" would be ignored
    • "[**]/four.txt" would be ignored
    • "[one]/one.txt, [two]/two.txt" would add one.txt and two.txt to the package

    • Type: String
  • caseSensitive (optional)
    Artifact archiver uses Ant org.apache.tools.ant.DirectoryScanner which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.

    This option can be used to disable case sensitivity. When it's unchecked, pattern "**/*.HPI" will match any *.hpi files, or pattern "**/cAsEsEnSiTiVe.jar" will match a file called caseSensitive.jar.
    • Type: boolean
  • defaultExcludes (optional)
    • Type: boolean
  • dependencies (optional)
    An array of strings, each consisting of a package identification string; this string is formatted as follows:
    • �group�:�package-name�
    • �group�:�package-name�:�version�
    When the version is not specified, the latest is used.
    • Type: String
  • description (optional)
    A string containing any number of charters; these will be formatted as Markdown in the ProGet UI
    • Type: String
  • excludes (optional)
    Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be archived even if it matches the mask specified in 'files to package' section.
    • Type: String
  • icon (optional)
    A string of an absolute url pointing to an image to be displayed in the ProGet UI (at both 64px and 128px); if package:// is used as the protocol, ProGet will search within the package and serve that image instead
    • Type: String
  • metadata (optional)
    Custom metadata in 'key = value' pairs, each key/value pair must be on it's own line so for more than one entry you will need to expand the entry field. Each key must be unique. Each value must be no more than 50 characters.

    If you need to add additional metadata, it's strongly recommended that you prefix these properties with an underscore (_) on the off-chance that a property you add will exist in a future version of the specification.

    • Type: String
  • title (optional)
    An optional title for your package

    A string of no more than fifty characters

    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.