Skip to content

Commit 9391f99

Browse files
committed
Update docs with manual mode
1 parent 544cf8a commit 9391f99

File tree

2 files changed

+20
-6
lines changed

2 files changed

+20
-6
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/b2268086565/ui-bundle.zip
12+
url: https://github.com/countableSet/antora-ui/releases/download/b2593412518/ui-bundle.zip
1313
snapshot: true
1414
supplemental_files:
1515
- path: partials/header-content.hbs

docs/modules/ROOT/pages/index.adoc

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Home
2+
:version: 0.1.3
23

34
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.
45

@@ -8,11 +9,11 @@ image::semantic-version-plugin.svg[]
89

910
link:https://plugins.gradle.org/plugin/dev.poolside.gradle.semantic-version[Plugins Page]
1011

11-
[source,kotlin]
12+
[source,kotlin,subs="attributes"]
1213
----
1314
plugins {
1415
`maven-publish`
15-
id("dev.poolside.gradle.semantic-version") version "0.1.0"
16+
id("dev.poolside.gradle.semantic-version") version "{version}"
1617
}
1718
----
1819

@@ -27,14 +28,16 @@ Resolved published version of 'dev.poolside.test:my-library:0.1.4' to '0.1.5'
2728

2829
== Usage
2930

31+
=== Auto mode
32+
3033
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]+`.
3134

32-
[source,kotlin]
35+
[source,kotlin,subs="attributes"]
3336
----
3437
plugins {
3538
java
3639
`maven-publish`
37-
id("dev.poolside.gradle.semantic-version") version "0.1.0"
40+
id("dev.poolside.gradle.semantic-version") version "{version}"
3841
}
3942
repositories {
4043
mavenCentral()
@@ -51,4 +54,15 @@ publishing {
5154
}
5255
}
5356
}
54-
----
57+
----
58+
59+
=== Manual mode
60+
61+
If there's a scenario in which you want to manually increment the semantic version. Therefore, the plugin will disable publishing if the version already exists in the repository.
62+
63+
[source,kotlin]
64+
----
65+
semanticVersion {
66+
manual = true
67+
}
68+
----

0 commit comments

Comments
 (0)