From c1771bb98f6c891cde64441fcb5b48dbcc71fb19 Mon Sep 17 00:00:00 2001 From: Cedric Beust Date: Sun, 27 Mar 2016 18:33:16 -0700 Subject: [PATCH] Document Maven coordinates. --- documentation/index.html | 63 ++++++++++++++++++++++++++++------------ 1 file changed, 45 insertions(+), 18 deletions(-) diff --git a/documentation/index.html b/documentation/index.html index 7fde417..30ebb4e 100644 --- a/documentation/index.html +++ b/documentation/index.html @@ -216,27 +216,54 @@ dependencies { } -

- There are various kinds of dependencies: -

-
-
compile
-
Used to compile your project.
-
runtime
-
Not used at compile time but passed to the JVM to run your application.
-
provided
-
Used at compile time but not used to run your application.
-
exclude
-
Exclude the given dependencies from the classpath. You can either - specify a versioned id (e.g. "groupId:artifactId:version") or a versionless one - ("groupId:artifactId:").
-
+

Dependency types

-

Settings

+

+ There are various kinds of dependencies: +

+
+
compile
+
Used to compile your project.
+
runtime
+
Not used at compile time but passed to the JVM to run your application.
+
provided
+
Used at compile time but not used to run your application.
+
exclude
+
Exclude the given dependencies from the classpath. You can either + specify a versioned id (e.g. "groupId:artifactId:version") or a versionless one + ("groupId:artifactId:").
+
+ +

Dependency versions

+

+Kobalt lets you specify Maven coordinates in one line, such as "org.testng:testng:6.9.10". Note that Kobalt uses the Maven Coordinates defined in the Maven specification, which are a little bit different from the ones that Gradle uses. +

+

+ The standard format for such coordinates, as explained in the link above, is: +

+
+groupId:artifactId:packaging:classifier:version

- You can define settings that will apply to all your Kobalt builds by creating - the file ~/.config/kobalt/settings.xml: + packaging and classifier are optional and can be omitted. If version + is omitted, Kobalt will resolve the artifact to its latest version from all the specified repos. + Most of the time, you will only specify groupId, artifactId and version, but if you ever need to specify additional components such as packaging (sometimes referred to as "extension") or classifier, + please take note that these should appear before the version number.

+

+ For example, here is a Maven coordinate specifying a classifier: +

+
+# No version, resolves to the latest
+org.testng:testng:
+# Specifies an extension and a qualifier
+com.badlogicgames.gdx:gdx-platform:jar:natives-desktop:1.9.2
+ +

Settings

+

+ You can define settings that will apply to all your Kobalt builds by creating + the file ~/.config/kobalt/settings.xml: +

+ 
 <kobalt-settings>
     <localRepo>/Users/beust/my-kobalt-repo</localRepo>