Maven Resource

Deploys and retrieve artifacts from a Maven Repository Manager.

Source Configuration

• url: Required. The location of the repository.

• snapshot_url: Optional. The location of the snapshot repository.

• artifact: Required. The artifact coordinates in the form of groupId:artifactId:type[:classifier]

• username: Optional. Username for accessing an authenticated repository.

• password: Optional. Password for accessing an authenticated repository.

• disable_redeploy: Optional. If set to true, will not re-deploy a release if the artifact version has been previously deployed. NOTE: has no effect for -SNAPSHOT versions or snapshot_url.

• skip_cert_check: Optional. If set to true, will ignore all certificate errors when accessing an SSL repository. NOTE: this will supersede the repository_cert configuration if also specified.

• repository_cert: Optional. CA/server certificate to use when accessing an SSL repository. Example:

  repository_cert: |
    -----BEGIN CERTIFICATE-----
    MIIEowIBAAKCAQEAtCS10/f7W7lkQaSgD/mVeaSOvSF9ql4hf/zfMwfVGgHWjj+W
    <Lots more text>
    DWiJL+OFeg9kawcUL6hQ8JeXPhlImG6RTUffma9+iGQyyBMCGd1l
    -----END CERTIFICATE-----
  

• version_regexp: Optional. You can set a regex to follow specific versions like: 1.* or 1.2.*

Behavior

check: Check for new versions of the artifact.

Checks for new versions of the artifact by retrieving the maven-metadata.xml from the repository. Check will only look for new versions of the artifact, not any auxillary artifacts such as javadoc.

in: Fetch an artifact from a repository.

Download the artifact from the repository.

Parameters

• artifactItems: Optional. Map of auxillary artifacts to download alongside the primary artifact. Takes the form classifier: type. It's expected auxillary artifacts will follow normal naming conventions. E.g. if the primary artifact is my-webapp-0.0.1-beta.rc-2.jar, then the parameter javadoc: jar will search for my-webapp-0.0.1-beta.rc-2-javadoc.jar.

- get: artifact
  params:
    artifactItems:
      javadoc: jar
      sources: jar
      diagram: pdf
      classifier: packagingType

out: Deploy artifact to a repository.

Deploy the artifact to the Maven Repository Manager.

Parameters

• file: Required. The path to the artifact to deploy.

• pom_file: Recommended. The path to the pom.xml to deploy with the artifact.

• version_file: Required. The path to the version file

• files: Optional. Map of paths to auxillary artifacts to upload alongside the primary artifact. Takes the form classifier: artifact/path-to-artifact. The packing type will be deduced from the file extension. Warning: you will need to be careful with your glob pattern when specifying auxillary artifacts. You'll need to discern between the different file paths. For example, if your primary artifact is my-artifact-0.2.3.beta-rc.7.jar, your glob pattern will need to be...

- put: artifact
  params:
    file: artifact/my-artifact-*[0-9].*[0-9].*[0-9]-beta.*[0-9].jar
    files:
      javadoc: artifact/my-artifact-*-javadoc.jar

Examples

Resource configuration for an authenticated repository using a custom cert:

resource_types:
- name: maven-resource
  type: docker-image
  source:
    repository: nulldriver/maven-resource
    tag: latest

resources:
- name: artifact
  type: maven-resource
  source:
    url: https://myrepo.example.com/repository/maven-releases/
    snapshot_url: https://myrepo.example.com/repository/maven-snapshots/
    artifact: com.example:example-webapp:jar
    username: myuser
    password: mypass
    repository_cert: |
      -----BEGIN CERTIFICATE-----
      MIIEowIBAAKCAQEAtCS10/f7W7lkQaSgD/mVeaSOvSF9ql4hf/zfMwfVGgHWjj+W
      <Lots more text>
      DWiJL+OFeg9kawcUL6hQ8JeXPhlImG6RTUffma9+iGQyyBMCGd1l
      -----END CERTIFICATE-----

Build and deploy an artifact to a Maven Repository Manager:

jobs:
- name: build
  plan:
  - get: source-code
    trigger: true
  - task: build-artifact
    file: source-code/ci/build.yml
  - put: artifact
    params:
      file: task-output/example-webapp-*.jar
      pom_file: source-code/pom.xml

Retrieve an artifact and push to Cloud Foundry using cf-resource

jobs:
- name: deploy
  plan:
  - get: source-code
  - get: artifact
    trigger: true
  - put: cf
    params:
      manifest: source-code/manifest.yml
      path: artifact/example-webapp-*.jar

Retrieve an artifact along with auxillary artifacts, then deploy with a GitHub release:

jobs:
- name: my-job
  plan:
  - get: source-code
  - get: artifact
    trigger: true
    params:
      artifactItems:
        javadoc: jar
        stubs: jar
        diagram: pdf
  - task: generate-github-release
    file: pipeline-tasks/generate-github-release/task.yml
  - put: gh-release
    params:
      name: task-output/release-name
      tag: task-output/release-tag
      globs: [artifact/example-webapp-*]