Skip to content

Commit

Permalink
Update docs with manual mode
Browse files Browse the repository at this point in the history
  • Loading branch information
countableSet committed Jul 1, 2022
1 parent 544cf8a commit 9391f99
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
2 changes: 1 addition & 1 deletion antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ output:
clean: true
ui:
bundle:
url: https://github.com/countableSet/antora-ui/releases/download/b2268086565/ui-bundle.zip
url: https://github.com/countableSet/antora-ui/releases/download/b2593412518/ui-bundle.zip
snapshot: true
supplemental_files:
- path: partials/header-content.hbs
Expand Down
24 changes: 19 additions & 5 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Home
:version: 0.1.3

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.

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

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

[source,kotlin]
[source,kotlin,subs="attributes"]
----
plugins {
`maven-publish`
id("dev.poolside.gradle.semantic-version") version "0.1.0"
id("dev.poolside.gradle.semantic-version") version "{version}"
}
----

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

== Usage

=== Auto mode

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]+`.

[source,kotlin]
[source,kotlin,subs="attributes"]
----
plugins {
java
`maven-publish`
id("dev.poolside.gradle.semantic-version") version "0.1.0"
id("dev.poolside.gradle.semantic-version") version "{version}"
}
repositories {
mavenCentral()
Expand All @@ -51,4 +54,15 @@ publishing {
}
}
}
----
----

=== Manual mode

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.

[source,kotlin]
----
semanticVersion {
manual = true
}
----

0 comments on commit 9391f99

Please sign in to comment.