Skip to content

Commit

Permalink
add new research docs module
Browse files Browse the repository at this point in the history
  • Loading branch information
countableSet committed Aug 10, 2024
1 parent aabec61 commit 61fa1e9
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 18 deletions.
1 change: 1 addition & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ title: Semantic Version Plugin
version: ~
nav:
- modules/ROOT/nav.adoc
- modules/research/nav.adoc
1 change: 0 additions & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
* xref:index.adoc[]
* xref:references.adoc[]
2 changes: 2 additions & 0 deletions docs/modules/research/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* xref:references.adoc[]
* xref:gradle-plugin.adoc[]
Original file line number Diff line number Diff line change
@@ -1,25 +1,17 @@
= References
= Gradle Plugin Publishing

Information that I found helpful when writing this plugin

== General

. link:https://github.com/nebula-plugins/nebula-publishing-plugin[]
.. link:https://github.com/nebula-plugins/nebula-publishing-plugin/blob/aee3fb093c622e7b7c9eb75cb6dc2838c2bcf340/src/main/groovy/nebula/plugin/publishing/maven/MavenResolvedDependenciesPlugin.groovy[MavenResolvedDependenciesPlugin]
. link:https://stackoverflow.com/questions/20959558/in-gradle-how-can-i-generate-a-pom-file-with-dynamic-dependencies-resolved-to-t[editing pom info]

== pom.withXml
* link:https://plugins.gradle.org/docs/publish-plugin-new[plugin docs]
* link:https://plugins.gradle.org/u/poolside[user account]
Editing groovy dom nodes/nodelists/etc is a pain in kotlin. I found these links helpful.
. link:https://github.com/Kotlin/kotlinx.dom/blob/0fe219d942047468b361dc0594f1c443ebcf26c3/src/main/kotlin/Dom.kt[kotlinx.dom]
. link:https://github.com/gradle/kotlin-dsl-samples/issues/225[kotlin-dsl-sample issue]
. link:https://github.com/nebula-plugins/nebula-publishing-plugin/blob/575b55c72151e0fae35c4aea69ff77ae8db57455/src/main/groovy/nebula/plugin/publishing/maven/MavenRemoveInvalidDependenciesPlugin.groovy[groovy example]
It's easier to setup credentials via the login task then doing it manually in the gradle.properties file

== Gradle Plugin Publishing
[source,bash]
----
❯ gr login
----

* link:https://plugins.gradle.org/docs/publish-plugin-new[plugin docs]
* link:https://plugins.gradle.org/u/poolside[user account]
Then run the publish task:

[source,bash]
----
Expand Down
17 changes: 17 additions & 0 deletions docs/modules/research/pages/references.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
= References

Information that I found helpful when writing this plugin

== General

. link:https://github.com/nebula-plugins/nebula-publishing-plugin[]
.. link:https://github.com/nebula-plugins/nebula-publishing-plugin/blob/aee3fb093c622e7b7c9eb75cb6dc2838c2bcf340/src/main/groovy/nebula/plugin/publishing/maven/MavenResolvedDependenciesPlugin.groovy[MavenResolvedDependenciesPlugin]
. link:https://stackoverflow.com/questions/20959558/in-gradle-how-can-i-generate-a-pom-file-with-dynamic-dependencies-resolved-to-t[editing pom info]

== pom.withXml

Editing groovy dom nodes/nodelists/etc is a pain in kotlin. I found these links helpful.

. link:https://github.com/Kotlin/kotlinx.dom/blob/0fe219d942047468b361dc0594f1c443ebcf26c3/src/main/kotlin/Dom.kt[kotlinx.dom]
. link:https://github.com/gradle/kotlin-dsl-samples/issues/225[kotlin-dsl-sample issue]
. link:https://github.com/nebula-plugins/nebula-publishing-plugin/blob/575b55c72151e0fae35c4aea69ff77ae8db57455/src/main/groovy/nebula/plugin/publishing/maven/MavenRemoveInvalidDependenciesPlugin.groovy[groovy example]

0 comments on commit 61fa1e9

Please sign in to comment.