Skip to content

Commit ae867e6

Browse files
committed
update docs with more info
1 parent 32c6def commit ae867e6

File tree

3 files changed

+49
-1
lines changed

3 files changed

+49
-1
lines changed

antora-playbook.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ output:
99
clean: true
1010
ui:
1111
bundle:
12-
url: https://github.com/countableSet/antora-ui/releases/download/b2213746648/ui-bundle.zip
12+
url: https://github.com/countableSet/antora-ui/releases/download/b2268086565/ui-bundle.zip
1313
snapshot: true
1414
supplemental_files:
1515
- path: partials/header-content.hbs

docs/modules/ROOT/images/semantic-version-plugin.svg

Lines changed: 16 additions & 0 deletions
Loading

docs/modules/ROOT/pages/index.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Gradle plugin to auto-increment patch version on each call to `publish` task by looking up the most recent version published in the configured maven repository.
44

5+
image::semantic-version-plugin.svg[]
6+
7+
== Import
8+
59
[source,kotlin]
610
----
711
plugins {
@@ -18,3 +22,31 @@ $ ./gradlw publish
1822
Resolved published version of 'dev.poolside.test:my-library:0.1.4' to '0.1.5'
1923
[...]
2024
----
25+
26+
== Usage
27+
28+
Basic full example, but it can also be used for subprojects and bom subprojects. However, make sure the publication version number is in the format of `[\d]+\.[\d]+`.
29+
30+
[source,kotlin]
31+
----
32+
plugins {
33+
java
34+
`maven-publish`
35+
id("dev.poolside.gradle.semantic-version") version "0.1.0"
36+
}
37+
repositories {
38+
mavenCentral()
39+
}
40+
41+
group = "dev.poolside.test"
42+
version = "0.1"
43+
44+
publishing {
45+
publications {
46+
create<MavenPublication>("mavenJava") {
47+
artifactId = "my-library"
48+
from(components["java"])
49+
}
50+
}
51+
}
52+
----

0 commit comments

Comments
 (0)