otty / dotfiles

All tools/Apache Maven

Apache Maven

maven

Apache Maven is a software project management and comprehension tool.

Detected by mvn | macOS, Linux, Windows |maven.apache.org

Sync it maven.toml

Sync rules

What travels, what stays, what never leaves

Synced2 paths, copied whole to your other machines

~/.m2/settings.xml

~/.m2/toolchains.xml

Never synced1 credential path, never uploaded in any form

~/.m2/settings-security.xml

Otty extracts these into your secret store instead of syncing the files. Every generated manager config below leaves them out too.

Secret fieldsInside a file that otherwise syncs

~/.m2/settings.xmllines starting with

<password><passphrase>

The rest of the file syncs. Only these values are lifted out and kept in your secret store.

Stays on this machineInside a file that otherwise syncs

~/.m2/settings.xmllines starting with <localRepository>

…

<settings xmlns="http://maven.apache.org/SETTINGS/1.2.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.2.0 https://maven.apache.org/xsd/settings-1.2.0.xsd">

<localRepository>/Users/octocat/.m2/repository</localRepository>machine-local

<interactiveMode>true</interactiveMode>

<offline>false</offline>

…

Otty splits these out before upload and puts each machine’s own back on the way down — no templates to write. The lines above come from this tool’s test fixture in the catalog.

Stays on this machineInside a file that otherwise syncs

~/.m2/toolchains.xmllines starting with <jdkHome>

…

<vendor>temurin</vendor>

</provides>

<configuration>

<jdkHome>/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home</jdkHome>machine-local

</configuration>

</toolchain>

<toolchain>

…

<vendor>temurin</vendor>

</provides>

<configuration>

<jdkHome>/Library/Java/JavaVirtualMachines/temurin-21.jdk/Contents/Home</jdkHome>machine-local

</configuration>

</toolchain>

</toolchains>

Otty splits these out before upload and puts each machine’s own back on the way down — no templates to write. The lines above come from this tool’s test fixture in the catalog.

Excluded2 paths, state rather than configuration — never uploaded

~/.m2/repository/directory

~/.m2/wrapper/directory

Not a subtraction from the paths above: this is everything else Apache Maven writes in your home directory that is state, not configuration. It keeps a whole-home manager like chezmoi from sweeping those up, and it still holds if the synced paths are ever widened.

Apache Maven in your home directory Every rule on this page, by file

…

<settings xmlns="http://maven.apache.org/SETTINGS/1.2.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.2.0 https://maven.apache.org/xsd/settings-1.2.0.xsd">

<localRepository>/Users/octocat/.m2/repository</localRepository>machine-local

<interactiveMode>true</interactiveMode>

<offline>false</offline>

…

Each machine keeps its own copy of these.

<password><passphrase>

Lifted into your secret store; the rest of the file syncs.

…

<vendor>temurin</vendor>

</provides>

<configuration>

<jdkHome>/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home</jdkHome>machine-local

</configuration>

</toolchain>

<toolchain>

…

<vendor>temurin</vendor>

</provides>

<configuration>

<jdkHome>/Library/Java/JavaVirtualMachines/temurin-21.jdk/Contents/Home</jdkHome>machine-local

</configuration>

</toolchain>

</toolchains>

Each machine keeps its own copy of these.

· repository/ Exclude

· wrapper/ Exclude

· settings-security.xml Never synced

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/maven.tomlThe file this page is generated from

id = "maven"

name = "Apache Maven"

homepage = "https://maven.apache.org"

description = "Apache Maven is a software project management and comprehension tool."

icon = "SimpleIcons:apachemaven"

detect = ["mvn"]

# https://maven.apache.org/settings.html — "${user.home}/.m2/settings.xml" is

# the user-level settings file; the global ${maven.home}/conf/settings.xml is

# not user-level and is not listed. toolchains.xml sits beside it, per

# https://maven.apache.org/guides/mini/guide-using-toolchains.html.

# On Windows ${user.home} is the user profile, so both are the same ~/ paths

# once the consumer resolves them.

paths = [

"~/.m2/settings.xml",

"~/.m2/toolchains.xml",

]

# The local repository and the Maven Wrapper distributions are downloaded

# artifacts, not configuration.

exclude = [

"~/.m2/repository/",

"~/.m2/wrapper/",

]

# https://maven.apache.org/guides/mini/guide-encryption.html — settings-security.xml

# holds "<master>", the master password every other encrypted password in

# settings.xml is derived from. The whole file is that one credential.

secret = ["~/.m2/settings-security.xml"]

# Read when Maven starts and held for the build.

# <server> entries carry the repository credentials. Maven writes one element

# per line, so the line-oriented prefix syntax reaches them; a value split

# across lines would not be matched, which is why a consumer is still expected

# to scan the file it syncs. Everything else in settings.xml — mirrors,

# proxies, profiles, pluginGroups — is worth carrying between machines, so the

# file is synced and only these two elements are lifted out.

[[secret_paths]]

file = "~/.m2/settings.xml"

match = { prefix = ["<password>", "<passphrase>"] }

# <localRepository> is an absolute path to this machine's disk. It is written

# only when the user moves the repository off the default, and where they put

# it is worth keeping so they can rebuild this machine.

[[machine_lines]]

file = "~/.m2/settings.xml"

match = { prefix = ["<localRepository>"] }

scope = "backup"

# <jdkHome> is where a JDK happens to be installed on this machine — a

# Homebrew prefix here, /usr/lib/jvm there, a drive letter on Windows. The

# location follows from the OS and architecture the JDK was installed for, so

# it holds for every machine of that class.

[[machine_lines]]

file = "~/.m2/toolchains.xml"

match = { prefix = ["<jdkHome>"] }

scope = "platform"

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/maven. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these keeps the credential file out. None of them splits <localRepository> and <jdkHome> for you — that part is Otty’s own sync, or a template you write by hand.