Fork me on GitHub
Built by Maven

wagon:upload

Full name:

org.codehaus.mojo:wagon-maven-plugin:3.0.0:upload

Description:

Upload multiple sets of files.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

Required Parameters

Name Type Since Description
<url> String - URL to upload to or download from or list. Must exist and point to a directory.
User Property: wagon.url

Optional Parameters

Name Type Since Description
<excludes> String - Comma separate list of Ant's excludes to scan for local files.
User Property: wagon.excludes
<followSymLink> boolean - Follow local symbolic link if possible.
Default: false
User Property: wagon.followSymLink
<fromDir> File - Local directory to upload to wagon's "url/toDir".
Default: ${project.basedir}
User Property: wagon.fromDir
<includes> String - Comma separate list of Ant's includes to scan for local files.
User Property: wagon.includes
<optimize> boolean - Optimize the upload by locally compressed all files in one bundle, upload the bundle, and finally remote uncompress the bundle.
Default: false
User Property: wagon.optimize
<serverId> String - settings.xml's server id for the URL. This is used when wagon needs extra authentication information.
Default: serverId
User Property: wagon.serverId
<skip> boolean 2.0.0 When true, skip the execution.
User Property: wagon.skip
<toDir> String - Remote path relative to Wagon's url to upload local files to.
User Property: wagon.toDir
<useDefaultExcludes> boolean - Use default exclude sets.
Default: true
User Property: wagon.useDefaultExcludes

Parameter Details

<excludes>

Comma separate list of Ant's excludes to scan for local files.
  • Type: java.lang.String
  • Required: No
  • User Property: wagon.excludes

<followSymLink>

Follow local symbolic link if possible.
  • Type: boolean
  • Required: No
  • User Property: wagon.followSymLink
  • Default: false

<fromDir>

Local directory to upload to wagon's "url/toDir".
  • Type: java.io.File
  • Required: No
  • User Property: wagon.fromDir
  • Default: ${project.basedir}

<includes>

Comma separate list of Ant's includes to scan for local files.
  • Type: java.lang.String
  • Required: No
  • User Property: wagon.includes

<optimize>

Optimize the upload by locally compressed all files in one bundle, upload the bundle, and finally remote uncompress the bundle.
  • Type: boolean
  • Required: No
  • User Property: wagon.optimize
  • Default: false

<serverId>

settings.xml's server id for the URL. This is used when wagon needs extra authentication information.
  • Type: java.lang.String
  • Required: No
  • User Property: wagon.serverId
  • Default: serverId

<skip>

When true, skip the execution.
  • Type: boolean
  • Since: 2.0.0
  • Required: No
  • User Property: wagon.skip

<toDir>

Remote path relative to Wagon's url to upload local files to.
  • Type: java.lang.String
  • Required: No
  • User Property: wagon.toDir

<url>

URL to upload to or download from or list. Must exist and point to a directory.
  • Type: java.lang.String
  • Required: Yes
  • User Property: wagon.url

<useDefaultExcludes>

Use default exclude sets.
  • Type: boolean
  • Required: No
  • User Property: wagon.useDefaultExcludes
  • Default: true