erik/kobalt-doc
erik/kobalt-doc
1
0
Fork 0
mirror of https://github.com/ethauvin/kobalt-doc.git synced 2025-04-25 03:57:11 -07:00
Code Releases Activity

Merge branch 'master' of github.com:cbeust/kobalt-doc

Browse source
This commit is contained in:
Cedric Beust 2016-06-25 09:19:11 -07:00
commit 2fa498b626
2 changed files with 38 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

59
documentation/index.html
View file

@ -229,6 +229,31 @@ dependencies {
}
</pre>
<h4 class="section" indent="2" id="dependency-versions">Dependency versions</h4>
<p>
Kobalt lets you specify Maven coordinates in one line, such as <code>"org.testng:testng:6.9.10"</code>. Note that Kobalt uses the <a href="https://maven.apache.org/pom.html#Maven_Coordinates">Maven Coordinates defined in the Maven specification</a>, which are a little bit different from the ones that Gradle uses.
</p>
<p>
The standard format for such coordinates, as explained in the link above, is:
</p>
<pre class="brush:plain">
groupId:artifactId:packaging:classifier:version</pre>
<p>
<code>packaging</code> (e.g. <code>"jar"</code>) and <code>classifier</code> (usually an arbitrary name) are optional and can be omitted. If <code>version</code>
is omitted, Kobalt will resolve the artifact to its latest version from all the specified repos.
Most of the time, you will only specify <code>groupId</code>, <code>artifactId</code> and <code>version</code>, but if you ever need to specify additional components such as <code>packaging</code> (sometimes referred to as "<code>extension</code>") or <code>classifier</code>,
please take note that these should appear before the version number.
</p>
<p>
Here are a few examples of valid Maven coordinates:
</p>
<pre class="brush:plain">
# 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</pre>
<h4 class="section" indent="2" id="dependency-types">Dependency types</h4>
<p>
@ -245,33 +270,21 @@ dependencies {
<dd>Exclude the given dependencies from the classpath. You can either
specify a versioned id (e.g. <code>"groupId:artifactId:version"</code>) or a versionless one
(<code>"groupId:artifactId:"</code>).</dd>
<dt>native</dt>
<dd>Used to define native dependencies.</dd>
</dl>
<h4 class="section" indent="2" id="dependency-versions">Dependency versions</h4>
<h5 class="section" indent="3" id="native-dependencies">Native dependencies</h5>
<p>
Kobalt lets you specify Maven coordinates in one line, such as <code>"org.testng:testng:6.9.10"</code>. Note that Kobalt uses the <a href="https://maven.apache.org/pom.html#Maven_Coordinates">Maven Coordinates defined in the Maven specification</a>, which are a little bit different from the ones that Gradle uses.
Native dependencies will only be used when you invoke the <code>run</code> task on your project:
</p>
<p>
The standard format for such coordinates, as explained in the link above, is:
</p>
<pre class="brush:plain">
groupId:artifactId:packaging:classifier:version</pre>
<p>
<code>packaging</code> and <code>classifier</code> are optional and can be omitted. If <code>version</code>
is omitted, Kobalt will resolve the artifact to its latest version from all the specified repos.
Most of the time, you will only specify <code>groupId</code>, <code>artifactId</code> and <code>version</code>, but if you ever need to specify additional components such as <code>packaging</code> (sometimes referred to as "<code>extension</code>") or <code>classifier</code>,
please take note that these should appear before the version number.
</p>
<p>
Here are a few examples of valid Maven coordinates:
</p>
<pre class="brush:plain">
# 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</pre>
<pre class="brush:java">
dependencies {
native("org.lwjgl.lwjgl:lwjgl-platform:jar:natives-windows:2.9.3",
"org.lwjgl.lwjgl:lwjgl-platform:jar:natives-linux:2.9.3",
"org.lwjgl.lwjgl:lwjgl-platform:jar:natives-osx:2.9.3"
)
}</pre>
<h2 class="section" id="settings">Settings</h2>
<p>
You can define settings that will apply to all your Kobalt builds by creating

5
plug-in-development/index.html
View file

@ -474,9 +474,8 @@ The <code>@Task</code> annotation accepts the following attributes:
</p>
<p>
Orderings, controlled by <code>"runBefore"</code> and <code>"runAfter"</code> merely specify an ordering
but do not pull new tasks in. This is how you tell Kobalt "In case task X is run, run my task before it
(or after)". But if task X doesn't run, your task will not be run either (unless it's explicitly requested
by the user).
but do not pull new tasks in. This is how you tell Kobalt "In case the user asks for my task to run,
here is when it should be invoked", but your task will run only if it's explicitly invoked by the user.
</p>
<p>
Here are a few different scenarios to illustrate how the three attributes work for the task <code>example</code>: