Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
settings

GitHub Action

maven-settings-action

v2.2.0

maven-settings-action

settings

maven-settings-action

Prepare maven settings.xml

Installation

Copy and paste the following snippet into your .yml file.

              

- name: maven-settings-action

uses: s4u/maven-settings-action@v2.2.0

Learn more about this action in s4u/maven-settings-action

Choose a version

maven-settings-action

Test Audit

This action setup maven environment for use in action by:

  • create maven settings.xml
  • set interactiveMode to false - useful in CI system
  • after job finish generated settings.xml will be removed to prevent cache or left sensitive data on build system
  • add server to servers with id=github, username=$GITHUB_ACTOR and password=$GITHUB_TOKEN

Contributions

  • Contributions are welcome!
  • Give ⭐ - if you want to encourage me to work on a project
  • Don't hesitate create issue for new feature you dream of or if you suspect some bug

Project versioning

Project use Semantic Versioning. We recommended to use the latest and specific release version.

In order to keep your project dependencies up to date you can watch this repository (Releases only) or use automatic tools like Dependabot.

Usage

See action.yml

Create default settings.xml:

steps:
- uses: s4u/maven-settings-action@v2.2.0

Create settings.xml with servers section:

steps:
- uses: s4u/maven-settings-action@v2.2.0
  with:
    servers: '[{"id": "serverId", "username": "username", "password": "password"}]'

Create settings.xml with mirrors section:

steps:
- uses: s4u/maven-settings-action@v2.2.0
  with:
    mirrors: '[{"id": "mirrorId", "name": "mirrorName", "mirrorOf": "mirrorOf", "url": "mirrorUrl"}]'

Create settings.xml with maven properties:

steps:
- uses: s4u/maven-settings-action@v2.2.0
  with:
    properties: '[{"propertyName1": "propertyValue1"}, {"propertyName2": "propertyValue2"}]'

Create settings.xml with https://oss.sonatype.org/content/repositories/snapshots in repository list

steps:
- uses: s4u/maven-settings-action@v2.2.0
  with:
    sonatypeSnapshots: true

Create settings.xml with https://repository.apache.org/snapshots/ in repository list

steps:
- uses: s4u/maven-settings-action@v2.2.0
  with:
    apacheSnapshots: true

Do not override existing settings.xml, from version 2.0 file is override by default :

steps:
- uses: s4u/maven-settings-action@v2.2.0
  with:
    override: false

Do not add github to server in settings.xml, by default is added:

steps:
- uses: s4u/maven-settings-action@v2.2.0
  with:
    githubServer: false

Create settings.xml with special server item configuration for oracle repository Oracle Maven Repository

steps:
- uses: s4u/maven-settings-action@v2.2.0
  with:
    oracleServers: '[{"id": "serverId", "username": "username", "password": "password"}]'

Create settings.xml with Oracle Maven Repository

steps:
- uses: s4u/maven-settings-action@v2.2.0
  with:
    oracleRepo: true

License

The scripts and documentation in this project are released under the MIT License