Migrate doc sites to MkDocs (#1302)

* Delete package.json and yarn.lock

* Move docs folder out of src

* Run `mkdocs new .`

https://squidfunk.github.io/mkdocs-material

* Update mkdocs.yml and nav items

* Delete .vuepress things

* Disable the explicit home page

* Remove gitPublish and node plugins

* Inline releaseAll task

* Add a job for testing deploying

* Update dokka output dir

* Tweak the deployment step

* Update release workflow

* Update ignore list

* Update changelog

* Add Dokka output into delete list

Author: Goooler

.github/pull_request_template.md

@@ -1,3 +1,3 @@
 ---
 
-- [ ] [CHANGELOG](https://github.com/GradleUp/shadow/blob/main/src/docs/changes/README.md)'s "Unreleased" section has been updated, if applicable.
+- [ ] [CHANGELOG](https://github.com/GradleUp/shadow/blob/main/docs/changes/README.md)'s "Unreleased" section has been updated, if applicable.

.github/workflows/release.yml

@@ -20,31 +20,26 @@ jobs:
       - uses: gradle/actions/setup-gradle@v4
         with:
           cache-read-only: true
-      - uses: actions/setup-node@v4
-        with:
-          # Due to some limitations of https://github.com/node-gradle/gradle-node-plugin.
-          node-version: '16'
-      # Used for gitPublish tasks.
-      - name: Set up Git
-        run: |
-          git config --global user.name 'github-actions[bot]'
-          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
       # Disable CC due to https://github.com/gradle/gradle/issues/22779
-      - run: ./gradlew releaseAll --no-configuration-cache
+      - run: ./gradlew publish publishPlugins dokkaHtml --no-configuration-cache
         env:
           GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_KEY }}
           GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_SECRET }}
-          GITHUB_USER: ${{ github.repository_owner }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.OSSRH_USER }}
           ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.OSSRH_PASSWORD }}
           ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_KEY }}
           ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.GPG_KEY_PASSWORD }}
+      - name: Deploy site
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          pip install mkdocs-material
+          mkdocs gh-deploy --force
       - name: Extract release notes
         # TODO: replace this after https://github.com/ffurrer2/extract-release-notes/pull/355 is merged.
         uses: Goooler/extract-release-notes@6e686e7a607d03716b7cff561371a82065b22c33
         with:
-          changelog_file: src/docs/changes/README.md
+          changelog_file: docs/changes/README.md
           release_notes_file: RELEASE_NOTES.md
       - name: Create release
         run: gh release create ${{ github.ref_name }} --notes-file RELEASE_NOTES.md

.gitignore

@@ -10,11 +10,10 @@ out
 .gradletasknamecache
 .gradle-test-kit
 classes/
-node_modules/
-yarn-error.log
-src/docs/.vuepress/dist/
 .DS_Store
 jd-gui.cfg
 bin/
 .vscode/
 .kotlin
+# Generated by Dokka, it's depended on by MkDocs.
+docs/api/

README.md

@@ -12,7 +12,7 @@ Gradle plugin for creating fat/uber JARs with support for package relocation.
 ## Documentation
 
 - [User Guide](https://gradleup.com/shadow/)
-- [CHANGELOG](src/docs/changes/README.md)
+- [CHANGELOG](docs/changes/README.md)
 
 ## Current Status
 

RELEASING.md

@@ -2,7 +2,7 @@
 
 1. Update the `VERSION_NAME` in `gradle.properties` to the release version.
 
-2. Update the [changelog](src/docs/changes/README.md):
+2. Update the [changelog](docs/changes/README.md):
    1. Change the `Unreleased` header to the release version.
    2. Add a link URL to ensure the header link works.
    3. Add a new `Unreleased` section to the top.

build-logic/build.gradle.kts

@@ -5,7 +5,5 @@ plugins {
 dependencies {
   implementation(libs.pluginPublish)
   implementation(libs.mavenPublish)
-  implementation(libs.gitPublish)
-  implementation(libs.node)
   implementation(libs.jetbrains.dokka)
 }

build-logic/src/main/kotlin/shadow.convention.deploy.gradle.kts

@@ -28,6 +28,10 @@ gradlePlugin {
   }
 }
 
+tasks.dokkaHtml {
+  outputDirectory = rootDir.resolve("docs/api")
+}
+
 tasks.publishPlugins {
   doFirst {
     if (version.toString().endsWith("SNAPSHOT")) {

build-logic/src/main/kotlin/shadow.convention.publish.gradle.kts

@@ -9,7 +9,6 @@ plugins {
   alias(libs.plugins.jetbrains.bcv)
   alias(libs.plugins.spotless)
   id("shadow.convention.publish")
-  id("shadow.convention.deploy")
 }
 
 java {
@@ -77,8 +76,8 @@ testing.suites {
   register<JvmTestSuite>("integrationTest") {
     targets.configureEach {
       testTask {
-        val docsDir = file("src/docs")
-        // Add src/docs as an input directory to trigger ManualCodeSnippetTests re-run on changes.
+        val docsDir = file("docs")
+        // Add docs as an input directory to trigger ManualCodeSnippetTests re-run on changes.
         inputs.dir(docsDir)
         systemProperty("DOCS_DIR", docsDir.absolutePath)
       }
@@ -176,16 +175,5 @@ tasks.clean {
   val dirs = includedBuilds.map { it.projectDir } + projectDir
   delete.addAll(dirs.map { it.resolve(".gradle") })
   delete.addAll(dirs.map { it.resolve(".kotlin") })
-  delete.add("node_modules")
-}
-
-tasks.register("releaseAll") {
-  description = "Publishes the plugin to maven repos and deploys website."
-  group = PublishingPlugin.PUBLISH_TASK_GROUP
-
-  dependsOn(
-    tasks.publish,
-    tasks.publishPlugins,
-    tasks.gitPublishPush,
-  )
+  delete.add(tasks.dokkaHtml.map { it.outputDirectory })
 }

build.gradle.kts

@@ -0,0 +1,16 @@
+<div style="text-align: center;">
+  <img src="images/logo.svg" alt="Gradle Shadow Plugin" style="max-width: 300px; height: auto;">
+  <h1><strong>Shadow Gradle Plugin</strong></h1>
+  <p><em>The library author's dependency toolkit</em></p>
+</div>
+
+---
+
+Previously this plugin was developed by [@johnrengelman](https://github.com/johnrengelman) and published under the ID [
+`com.github.johnrengelman.shadow`](https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow)
+before maintenance was transferred to the [GradleUp organization](https://github.com/GradleUp) to ensure future
+development, see [#908](https://github.com/GradleUp/shadow/issues/908).
+
+If you are still using the old plugin ID in your build script, we recommend to switch to the new plugin ID [
+`com.gradleup.shadow`](https://plugins.gradle.org/plugin/com.gradleup.shadow)
+and update to the latest version to receive all the latest bug fixes and improvements.

docs/README.md

@@ -13,6 +13,7 @@
 - **BREAKING CHANGE:** Rename `Transformer` to `ResourceTransformer`. ([#1288](https://github.com/GradleUp/shadow/pull/1288))  
   Aims to better align with the name of [org.apache.maven.plugins.shade.resource.ResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ResourceTransformer.java) and to distinguish itself from [org.gradle.api.Transformer.java](https://docs.gradle.org/current/javadoc/org/gradle/api/Transformer.html).
 - **BREAKING CHANGE:** Mark `DefaultInheritManifest` as `internal`. ([#1303](https://github.com/GradleUp/shadow/pull/1303))
+- Migrate doc sites to MkDocs. ([#1302](https://github.com/GradleUp/shadow/pull/1302))
 
 **Fixed**