downloads:upload

Full name:

com.github.github:downloads-maven-plugin:0.5:upload

Description:

Mojo that uploads a built resource as a GitHub repository download

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
project MavenProject - Project being built

Optional Parameters

Name Type Since Description
description String - Description of download
dryRun boolean - Show what downloads would be deleted and uploaded but don't actually alter the current set of repository downloads. Showing what downloads will be deleted does require still listing the current downloads available from the repository.
excludes String[] - Files to exclude
host String - Host for API calls
Default value is: ${github.global.host}.
includeAttached boolean - Include attached artifacts
includes String[] - Files to include
oauth2Token String - User name for authentication
Default value is: ${github.global.oauth2Token}.
override boolean - Override existing downloads
password String - User name for authentication
Default value is: ${github.global.password}.
repositoryName String - Name of repository to upload to
repositoryOwner String - Owner of repository to upload to
server String - Id of server to use
Default value is: ${github.global.server}.
settings Settings - Settings
suffix String - Suffix to append to all uploaded files. The configured suffix will go before the file extension.
userName String - User name for authentication
Default value is: ${github.global.userName}.

Parameter Details

description:

Description of download
  • Type: java.lang.String
  • Required: No

dryRun:

Show what downloads would be deleted and uploaded but don't actually alter the current set of repository downloads. Showing what downloads will be deleted does require still listing the current downloads available from the repository.
  • Type: boolean
  • Required: No
  • Expression: ${github.downloads.dryRun}

excludes:

Files to exclude
  • Type: java.lang.String[]
  • Required: No

host:

Host for API calls
  • Type: java.lang.String
  • Required: No
  • Expression: ${github.downloads.host}
  • Default: ${github.global.host}

includeAttached:

Include attached artifacts
  • Type: boolean
  • Required: No
  • Expression: ${github.downloads.includeAttached}

includes:

Files to include
  • Type: java.lang.String[]
  • Required: No

oauth2Token:

User name for authentication
  • Type: java.lang.String
  • Required: No
  • Expression: ${github.downloads.oauth2Token}
  • Default: ${github.global.oauth2Token}

override:

Override existing downloads
  • Type: boolean
  • Required: No
  • Expression: ${github.downloads.override}

password:

User name for authentication
  • Type: java.lang.String
  • Required: No
  • Expression: ${github.downloads.password}
  • Default: ${github.global.password}

project:

Project being built
  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • Expression: ${project}

repositoryName:

Name of repository to upload to
  • Type: java.lang.String
  • Required: No
  • Expression: ${github.downloads.repositoryName}

repositoryOwner:

Owner of repository to upload to
  • Type: java.lang.String
  • Required: No
  • Expression: ${github.downloads.repositoryOwner}

server:

Id of server to use
  • Type: java.lang.String
  • Required: No
  • Expression: ${github.downloads.server}
  • Default: ${github.global.server}

settings:

Settings
  • Type: org.apache.maven.settings.Settings
  • Required: No
  • Expression: ${settings}

suffix:

Suffix to append to all uploaded files. The configured suffix will go before the file extension.
  • Type: java.lang.String
  • Required: No
  • Expression: ${github.downloads.suffix}

userName:

User name for authentication
  • Type: java.lang.String
  • Required: No
  • Expression: ${github.downloads.userName}
  • Default: ${github.global.userName}