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

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

Conflicts:
	plug-ins/index.html
This commit is contained in:
Cedric Beust 2016-08-01 08:01:11 -07:00
commit 9a53a4b34d
5 changed files with 85 additions and 34 deletions

View file

@ -217,7 +217,7 @@ dependencies {
}
dependenciesTest {
compile("org.testng:testng:6.9.5")
compile("org.testng:testng:")
}
</pre>
<p>
@ -292,13 +292,13 @@ dependencies {
</p>
<pre class="brush:plain">
&lt;kobalt-settings&gt;
&lt;local-repo&gt;/Users/beust/my-kobalt-repo&lt;/local-repo&gt;
&lt;default-repos&gt;
&lt;kobaltSettings&gt;
&lt;localCache&gt;/Users/beust/my-kobalt-repo&lt;/localCache&gt;
&lt;defaultRepos&gt;
&lt;repo&gt;http://jcenter.com&lt;/repo&gt;
&lt;repo&gt;http://example.com&lt;/repo&gt;
&lt;/default-repos&gt;
&lt;/kobalt-settings&gt;</pre>
&lt;/defaultRepos&gt;
&lt;/kobaltSettings&gt;</pre>
<p>
Here is a list of the parameters you can configure:
</p>
@ -317,25 +317,30 @@ dependencies {
</thead>
<tr>
<td><code>default-repos</code></td>
<td><code>defaultRepos</code></td>
<td><a href="https://github.com/cbeust/kobalt/blob/master/modules/kobalt-plugin-api/src/main/kotlin/com/beust/kobalt/Constants.kt#L10">Default repos</a></td>
<td>List of repos overriding the default ones that Kobalt uses.</td>
</tr>
<tr>
<td><code>kobalt-compiler-version</code></td>
<td>1.0.0</td>
<td><code>kobaltCompilerVersion</code></td>
<td>1.0.3</td>
<td>The version of the Kotlin compiler that Kobalt uses.</td>
</tr>
<tr>
<td><code>kobalt-compiler-repo</code></td>
<td><code>kobaltCompilerRepo</code></td>
<td>None</td>
<td>The Maven repository where to find the compiler. By default, the compiler is looked up in the default repos (JCenter, Maven, ...).</td>
</tr>
<tr>
<td><code>local-repo</code></td>
<td><code>~/.kobalt/repository</code></td>
<td><code>localCache</code></td>
<td><code>~/.kobalt/cache</code></td>
<td>Where Kobalt stores all the downloaded dependencies.</td>
</tr>
<tr>
<td><code>localMavenRepo</code></td>
<td><code>~/.kobalt/localMavenRepo</code></td>
<td>Where Kobalt publishes artifacts when the task <code>publishToLocalMaven</code> is invoked.</td>
</tr>
</table>
<h2 class="section" id="templates">Templates</h2>
@ -394,8 +399,8 @@ $ ./kobaltw --pluginJarFiles kobaltBuild/libs/kobalt-line-count-0.18.jar --tasks
$ ./kobaltw --plugins com.beust:kobalt-android: --listTemplates
Available templates
Plug-in: Kobalt
"java" Generates a simple Java project
"kotlin" Generates a simple Kotlin project
"java" Generate a simple Java project
"kotlin" Generate a simple Kotlin project
"kobaltPlugin" Generate a sample Kobalt plug-in project
Plug-in: Android
"androidJava" Generate a simple Android Java project
@ -605,7 +610,7 @@ Here are the options that you can pass to <code>./kobaltw</code>:
$ ./kobaltw --checkVersions
New versions found:
com.beust:klaxon:0.14
org.testng:testng:6.9.5
org.testng:testng:6.9.12
</pre>
</td>
</tr>
@ -659,6 +664,13 @@ New versions found:
<td>Specify the plug-ins to load.</td>
<td>This is similar to specifying these plug-in id's in a build file except that no build file is needed.</td>
</tr>
<tr>
<td><code>--profiling</code></td>
<td></td>
<td></td>
<td>Display timings for the build tasks.</td>
<td></td>
</tr>
<tr>
<td><code>--resolve</code></td>
<td>Maven id<br/>(e.g.&nbsp;<code>"com.beust:kobalt:0.228"</code>)</td>
@ -666,20 +678,20 @@ New versions found:
<td>Display information about the given id.</td>
<td>Display which repo this artifact can be found in and the whole graph of its dependencies.</td>
</tr>
<tr>
<td><code>--tasks</code></td>
<td>Boolean</td>
<td>false</td>
<td>List the tasks available.</td>
<td>Note that the available tasks will vary depending on which projects are in your build file.</td>
</tr>
<tr>
<td><code>--update</code></td>
<td>Boolean</td>
<td>false</td>
<td>Update Kobalt to the latest version available.</td>
<td>Use this flag if Kobalt just notified you that a new version is available and you want to update. Another way of doing this is to edit <code>kobalt/wrapper/kobalt-wrapper.properties</code> manually.</td>
</tr>
<tr>
<td><code>--tasks</code></td>
<td>Boolean</td>
<td>false</td>
<td>List the tasks available.</td>
<td>Note that the available tasks will vary depending on which projects are in your build file.</td>
</tr>
<tr>
<td><code>--update</code></td>
<td>Boolean</td>
<td>false</td>
<td>Update Kobalt to the latest version available.</td>
<td>Use this flag if Kobalt just notified you that a new version is available and you want to update. Another way of doing this is to edit <code>kobalt/wrapper/kobalt-wrapper.properties</code> manually.</td>
</tr>
</table>
<h2 class="section" id="testing">Testing</h2>

View file

@ -111,7 +111,7 @@ val jcommander = project {
version = "1.54"
dependenciesTest {
compile("org.testng:testng:6.9.9")
compile("org.testng:testng:")
}
assemble {

View file

@ -95,7 +95,7 @@ val jcommander = project {
version = "1.52"
dependenciesTest {
compile("org.testng:testng:6.9.5")
compile("org.testng:testng:")
}
assemble {

View file

@ -534,6 +534,44 @@ $ ./kobaltw uploadBintray
<dd>The first parameter is the file you want to upload and the second one is the path where it will be uploaded to.</dd>
</dl>
<h3 class="section" indent="1" id="configuring-pom">Configuring your POM file</h3>
<p>
When you upload your package to Bintray or JCenter in Maven form, Kobalt will create a default
POM file for you. You can configure it with the <code>pom{}</code> directive in your project.
Here is an example:
</p>
<pre class="brush:java">
import org.apache.maven.model.*
val kobalt = project {
pom = Model().apply {
name = project.name
description = "A build system in Kotlin"
url = "http://beust.com/kobalt"
licenses = listOf(License().apply {
name = "Apache 2.0"
url = "http://www.apache .org/licenses/LICENSE-2.0"
})
scm = Scm().apply {
url = "http://github.com/cbeust/kobalt"
connection = "https://github.com/cbeust/kobalt.git"
developerConnection = "git@github.com:cbeust/kobalt.git"
}
developers = listOf(Developer().apply {
name = "Cedric Beust"
email = "cedric@beust.com"
})
}
</pre>
<p>
Note that the classes used in this snippet (<code>Model</code>, <code>License</code>, etc...) are
the actual Apache Maven class, so you have access to the full POM model.
</p>
<!---
<h2 class="section" id="dokka">Dokka</h2>
<p>
@ -572,10 +610,11 @@ $ ./kobaltw uploadBintray
<dt>skip</dt>
<dd>If true, don't generate anything.</dd>
</dl>
-->
</div>
<!-- Table of contents -->
<div class="col-md-3" id="table-of-contents">
</div>

View file

@ -74,7 +74,7 @@
<pre class="brush:plain">
$ mkdir linecount
$ cd linecount
$ mkdir -p src/main/kotlin/com/beust/plugin/linecount
$ mkdir -p src/main/kotlin/com/beust/kobalt/plugin/linecount
$ $KOBALT_HOME/kobaltw --init kotlin
</pre>
@ -229,7 +229,7 @@ BUILD SUCCESSFUL (15 seconds)
<pre class="brush:java">
val repos = repos("https://dl.bintray.com/cbeust/maven/")
val plugins = plugins("com.beust.kobalt:kobalt-line-count:0.2")
val plugins = plugins("com.beust:kobalt-line-count:0.2")
</pre>
<p>