Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme dsl #5

Merged
merged 6 commits into from
Oct 9, 2024
Merged

Update readme dsl #5

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0d4fbd8
Update readme to use dsl, refine wording for Gradle config cache
pahill Oct 9, 2024
b497b3a
Update readme to use dsl, refine wording for Gradle config cache
pahill Oct 9, 2024
6aabaa7
Update readme to use dsl, refine wording for Gradle config cache
pahill Oct 9, 2024
008a76a
Update readme to use dsl, refine wording for Gradle config cache
pahill Oct 9, 2024
fd7f19f
Update readme to use dsl, refine wording for Gradle config cache
pahill Oct 9, 2024
5eb2a70
Update readme to use dsl, refine wording for Gradle config cache
pahill Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,8 @@ To add the plugin to your project, add the following line in the plugins block,

In the same file, add the following configuration. Customize all these values appropriately for your library.

| `mavenPublishing {`<br>` publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL)`<br>` signAllPublications()`<br>` coordinates("io.github.kotlin-hands-on", "fibonacci", "1.0.3")`<br>` pom {`<br>` name.set("Fibonacci library")`<br>` description.set("A mathematics calculation library.")`<br>` inceptionYear.set("2024")`<br>` url.set("https://github.com/kotlin-hands-on/fibonacci/")`<br>` licenses {`<br>` license {`<br>` name.set("The Apache License, Version 2.0")`<br>` url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")`<br>` distribution.set("http://www.apache.org/licenses/LICENSE-2.0.txt")`<br>` }`<br>` }`<br>` developers {`<br>` developer {`<br>` id.set("kotlin-hands-on")`<br>` name.set("Kotlin Developer Advocate")`<br>` url.set("https://github.com/kotlin-hands-on/")`<br>` }`<br>` }`<br>` scm {`<br>` url.set("https://github.com/kotlin-hands-on/fibonacci/")`<br>` connection.set("scm:git:git://github.com/kotlin-hands-on/fibonacci.git")`<br>` developerConnection.set("scm:git:ssh://[email protected]/kotlin-hands-on/fibonacci.git")`<br>` }`<br>` }`<br>` }` |
| :---- |
| `mavenPublishing {`<br>` publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL)`<br>` signAllPublications()`<br>` coordinates("io.github.kotlin-hands-on", "fibonacci", "1.0.8")`<br>` pom {`<br>` name = "Fibonacci library"`<br>` description = "A mathematics calculation library."`<br>` inceptionYear = "2024"`<br>` url = "https://github.com/kotlin-hands-on/fibonacci/"`<br>` licenses {`<br>` license {`<br>` name = "The Apache License, Version 2.0"`<br>` url = "http://www.apache.org/licenses/LICENSE-2.0.txt"`<br>` distribution = "http://www.apache.org/licenses/LICENSE-2.0.txt"`<br>` }`<br>` }`<br>` developers {`<br>` developer {`<br>` id = "kotlin-hands-on"`<br>` name = "Kotlin Developer Advocate"`<br>` url = "https://github.com/kotlin-hands-on/"`<br>` }`<br>` }`<br>` scm {`<br>` url = "https://github.com/kotlin-hands-on/fibonacci/"`<br>` connection "scm:git:git://github.com/kotlin-hands-on/fibonacci.git"`<br>` developerConnection = "scm:git:ssh://[email protected]/kotlin-hands-on/fibonacci.git"`<br>` }`<br>` }`<br>`}` |
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

Note that it’s also possible to use Gradle properties instead.

Expand All @@ -186,7 +186,7 @@ After committing and pushing this change, this workflow will run automatically w

\> Alternatively, you could configure the workflow to [trigger when a tag is pushed](https://stackoverflow.com/a/61892639) to your repository.

\> If you’re using Gradle [configuration cache](https://docs.gradle.org/current/userguide/configuration_cache.html), you’ll need to disable it for the publication task by adding `--no-configuration-cache` to the Gradle command, as the publication plugin does not support it (see this [open issue](https://github.com/gradle/gradle/issues/22779)).
\> The script above disables Gradle [configuration cache](https://docs.gradle.org/current/userguide/configuration_cache.html) for the publication task by adding `--no-configuration-cache` to the Gradle command, as the publication plugin does not support it (see this [open issue](https://github.com/gradle/gradle/issues/22779)).

\> Reminder: When using `publishToMavenCentral`, you’ll still need to check and release your deployment manually on the website, as described in the previous section. You may use `publishAndReleaseToMavenCentral` instead for a fully automated release.

Expand Down
Loading