example_config.yml

defaults:
  # relative or absolute path to a maven settings.xml
  fromMavenSettings: ./.m2/settings.xml
  # name of the repository in provided settings.xml
  fromMavenRepositoryId: gitlab-maven
  # relative or absolute path to a maven settings.xml
  toMavenSettings: ./.m2/settings.xml
  # name of the repository in provided settings.xml
  toRepositoryId: gitlab-maven
  # additional http header map, use this for authentication
  customHeader:
  # NAME:VALUE, e.g. Authorization:Basic basicAuthString
  # example for environment variable: PRIVATE-TOKEN: "${PRIVATE_TOKEN}"

  # raw python regex for semantic versioning, the first and last quotes are escaped for yaml parser
  versionFilterPattern: \"^.*\\d+\.\\d+\.\\d+(:?-SNAPSHOT)?$\"
  classifier:
    # <maven classifier>[:package type], e.g. sources:jar or
    - "sources:jar"
    - "debug:jar"
  types: jar,pdf,html
  # boolean, this flag controls if packages are pushed to the remote repository
  enableRemoteSync: false
  # boolean, transitive dependency resolution during get/deploy
  transitive: true
  # integer, limit amount of versions after descending alphabetical sort of versions.
  # Numbers smaller than 1 mean indefinite depth.
  syncDepth: 0

mirrors:
  - fromURL: https://example.maven.repo/packages/maven
    # or use "local" for "toUrl"
    toURL: https://other-example.maven.repo/packages/maven

  # Examples

  # GitLab package mirror to local repository example
  - fromURL: https://git.example.com/api/v4/projects/<ID>/packages/maven
    #toURL: local
    toURL: https://git.example.com/api/v4/projects/<ID>/packages/maven
    # override default
    versionFilterPattern:
    enableRemoteSync: true
    classifier:
      - "sources:jar"
      - "javadoc:jar"
    customHeader:
      # make sure the environment variable is set
      PRIVATE-TOKEN: "${PRIVATE_TOKEN}"
    packages:
      - "com.example.java:core"

  # AWS CodeArtifact example - mirror packages from repo A to B
  - fromURL: https://maven-123456789.d.codeartifact.eu-central-1.amazonaws.com/maven/project-libraries
    toURL: https://maven-987654321.d.codeartifact.eu-central-1.amazonaws.com/maven/project-libraries
    fromMavenSettings: ./.m2/settings.xml
    fromMavenRepositoryId: projectXY-codeartifact
    toMavenSettings: ./.m2/settings_new.xml
    toRepositoryId: projectXY-codeartifact
    customHeader:
      Authorization: Bearer eyJ2ZXI...
    versionFilterPattern:
    classifier:
      - "sources:jar"
    types: jar,pdf,html
    enableRemoteSync: true
    transitive: true
    syncDepth: 0
    packages:
      - "com.example.project:project-core"
      - "com.example.project:project-test"
      - "com.example.project:project-libraryXY"

mavenDependencyPluginVersion: 3.6.0
mavenDeployPluginVersion: 3.1.2