diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 80cfe7b43..07e0295fa 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ -Please check the [User Guide](http://imperceptiblethoughts.com/shadow) before submitting "how do I do 'x'?" questions! +Please check the [User Guide](https://gradleup.com/shadow) before submitting "how do I do 'x'?" questions! ### Shadow Version diff --git a/README.md b/README.md index 0cdb7df86..c01e8a2e6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Gradle plugin for creating fat/uber JARs with support for package relocation. ## Documentation -Read the [User Guide](https://imperceptiblethoughts.com/shadow/)! +Read the [User Guide](https://gradleup.com/shadow/)! ## Current Status diff --git a/src/docs/.vuepress/components/ApiLink.vue b/src/docs/.vuepress/components/ApiLink.vue index 6ff50a958..48b5cd3fc 100644 --- a/src/docs/.vuepress/components/ApiLink.vue +++ b/src/docs/.vuepress/components/ApiLink.vue @@ -6,7 +6,7 @@ export default { data () { return { - absolutePath: "http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/" + this.path + absolutePath: "https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/" + this.path } } } diff --git a/src/docs/README.md b/src/docs/README.md index 7675f3dfa..ce280896d 100644 --- a/src/docs/README.md +++ b/src/docs/README.md @@ -9,4 +9,4 @@ actionLink: /introduction/ John Engelman - @johnrengelman -[API Docs](http://imperceptiblethoughts.com/shadow/api/index.html) +[API Docs](https://gradleup.com/shadow/api/index.html) diff --git a/src/docs/changes/README.md b/src/docs/changes/README.md index a9dfcd1d3..f925fea69 100644 --- a/src/docs/changes/README.md +++ b/src/docs/changes/README.md @@ -198,7 +198,7 @@ Instead, use the `enableRelocation = true` and `relocationPrefix = " Note the literal use of `project.configurations` when setting the `configurations` attribute of a -[`ShadowJar`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) task. +[`ShadowJar`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) task. This is **required**. It maybe be tempting to specify `configurations = [configurations.compile]` but this will not have the intended effect, as `configurations.compile` will try to delegate to the `configurations` property of the -the [`ShadowJar`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) task instead of the `project` +the [`ShadowJar`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) task instead of the `project` ## Embedding Jar Files Inside Your Shadow Jar @@ -31,7 +31,7 @@ begins. ## Filtering Dependencies Individual dependencies can be filtered from the final JAR by using the `dependencies` block of a -[`ShadowJar`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) task. +[`ShadowJar`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) task. Dependency filtering does **not** apply to transitive dependencies. That is, excluding a dependency does not exclude any of its dependencies from the final JAR. @@ -135,7 +135,7 @@ tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.Shadow ### Programmatically Selecting Dependencies to Filter If more complex decisions are needed to select the dependencies to be included, the -[`dependencies`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html#dependencies(Action)) +[`dependencies`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html#dependencies(Action)) block provides a method that accepts a `Closure` for selecting dependencies. ```groovy diff --git a/src/docs/configuration/merging/README.md b/src/docs/configuration/merging/README.md index eeb27de96..72882fb65 100644 --- a/src/docs/configuration/merging/README.md +++ b/src/docs/configuration/merging/README.md @@ -1,11 +1,11 @@ # Controlling JAR Content Merging Shadow allows for customizing the process by which the output JAR is generated through the -[`Transformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/Transformer.html) interface. +[`Transformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/Transformer.html) interface. This is a concept that has been carried over from the original Maven Shade implementation. -A [`Transformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/Transformer.html) is invoked for each +A [`Transformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/Transformer.html) is invoked for each entry in the JAR before being written to the final output JAR. -This allows a [`Transformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/Transformer.html) to +This allows a [`Transformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/Transformer.html) to determine if it should process a particular entry and apply any modifications before writing the stream to the output. ```groovy @@ -94,7 +94,7 @@ At runtime, this file is read and used to configure library or application behav Multiple dependencies may use the same service descriptor file name. In this case, it is generally desired to merge the content of each instance of the file into a single output file. -The [`ServiceFileTransformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformer.html) +The [`ServiceFileTransformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformer.html) class is used to perform this merging. By default, it will merge each copy of a file under `META-INF/services` into a single file in the output JAR. @@ -106,17 +106,17 @@ tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.Shadow ``` The above code snippet is a convenience syntax for calling -[`transform(ServiceFileTransformer.class)`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html#transform(Class)). +[`transform(ServiceFileTransformer.class)`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html#transform(Class)). > Groovy Extension Module descriptor files (located at `META-INF/services/org.codehaus.groovy.runtime.ExtensionModule`) -are ignored by the [`ServiceFileTransformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformer.html). +are ignored by the [`ServiceFileTransformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformer.html). This is due to these files having a different syntax than standard service descriptor files. -Use the [`mergeGroovyExtensionModules()`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html#mergeGroovyExtensionModules()) method to merge +Use the [`mergeGroovyExtensionModules()`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html#mergeGroovyExtensionModules()) method to merge these files if your dependencies contain them. ### Configuring the Location of Service Descriptor Files -By default the [`ServiceFileTransformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformer.html) +By default the [`ServiceFileTransformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformer.html) is configured to merge files in `META-INF/services`. This directory can be overridden to merge descriptor files in a different location. @@ -131,7 +131,7 @@ tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.Shadow #### Excluding/Including Specific Service Descriptor Files From Merging -The [`ServiceFileTransformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformer.html) +The [`ServiceFileTransformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformer.html) class supports specifying specific files to include or exclude from merging. ```groovy @@ -147,9 +147,9 @@ tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.Shadow Shadow provides a specific transformer for dealing with Groovy extension module files. This is due to their special syntax and how they need to be merged together. -The [`GroovyExtensionModuleTransformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer.html) +The [`GroovyExtensionModuleTransformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer.html) will handle these files. -The [`ShadowJar`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) task also provides a short syntax +The [`ShadowJar`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) task also provides a short syntax method to add this transformer. ```groovy @@ -162,11 +162,11 @@ tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.Shadow ## Appending Text Files Generic text files can be appended together using the -[`AppendingTransformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/AppendingTransformer.html). +[`AppendingTransformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/AppendingTransformer.html). Each file is appended using new lines to separate content. -The [`ShadowJar`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) task provides a short syntax +The [`ShadowJar`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) task provides a short syntax method of -[`append(String)`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html#append(java.lang.String)) to +[`append(String)`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html#append(java.lang.String)) to configure this transformer. ```groovy @@ -179,10 +179,10 @@ tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.Shadow ## Appending XML Files XML files require a special transformer for merging. -The [`XmlAppendingTransformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/XmlAppendingTransformer.html) +The [`XmlAppendingTransformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/XmlAppendingTransformer.html) reads each XML document and merges each root element into a single document. -There is no short syntax method for the [`XmlAppendingTransformer`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/XmlAppendingTransformer.html). -It must be added using the [`transform`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow//tasks/ShadowJar.html#transform(Class)) methods. +There is no short syntax method for the [`XmlAppendingTransformer`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/transformers/XmlAppendingTransformer.html). +It must be added using the [`transform`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow//tasks/ShadowJar.html#transform(Class)) methods. ```groovy // Appending a XML File diff --git a/src/docs/custom-tasks/README.md b/src/docs/custom-tasks/README.md index d2cd0eb51..784c9bf6e 100644 --- a/src/docs/custom-tasks/README.md +++ b/src/docs/custom-tasks/README.md @@ -1,7 +1,7 @@ # Creating a Custom ShadowJar Task The built in `shadowJar` task only provides an output for the `main` source set of the project. -It is possible to add arbitrary [`ShadowJar`](http://imperceptiblethoughts.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) +It is possible to add arbitrary [`ShadowJar`](https://gradleup.com/shadow/api/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.html) tasks to a project. When doing so, ensure that the `configurations` property is specified to inform Shadow which dependencies to merge into the output.