Skip to content

Unify project description in README, docs, and metadata #2178

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

Merged
Goooler merged 5 commits into from
Aug 10, 2026
+6 −9
Merged

Unify project description in README, docs, and metadata #2178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2547cec
Update project description in README, docs, and metadata
Goooler Aug 10, 2026
cbd49f3
Potential fix for pull request finding
Goooler Aug 10, 2026
e694492
Replace `Maven’s`
Goooler Aug 10, 2026
c33661d
Prepend article 'A' to project description across docs and properties
Goooler Aug 10, 2026
5a3f4cd
Apply suggestions from code review
Goooler Aug 10, 2026
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Shadow

Gradle plugin for creating fat/uber JARs with support for package relocation.
A Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing applications
with R8/ProGuard. The Gradle counterpart to Maven's Shade plugin.

> [!NOTE]\
> Previously this plugin was developed by [@johnrengelman](https://github.com/johnrengelman) and published under the
Expand Down
8 changes: 2 additions & 6 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@

# Introduction

Shadow is a Gradle plugin for combining a project's dependency classes and resources into a single
output Jar. The combined Jar is often referred to a _fat-jar_ or _uber-jar_.
Shadow utilizes [`JarInputStream`][JarInputStream] and [`JarOutputStream`][JarOutputStream] to efficiently process
dependent libraries into the output jar without incurring the I/O overhead of expanding the jars to disk.
A Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing applications
with R8/ProGuard. The Gradle counterpart to Maven's Shade plugin.

!!! warning "Plugin ID Change"

Expand Down Expand Up @@ -68,7 +66,5 @@ library's dependencies will not conflict with the same dependency being declared



[JarInputStream]: https://docs.oracle.com/javase/8/docs/api/java/util/jar/JarInputStream.html
[JarOutputStream]: https://docs.oracle.com/javase/8/docs/api/java/util/jar/JarOutputStream.html
[johnrengelman's]: https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow
[gradleup's]: https://plugins.gradle.org/plugin/com.gradleup.shadow
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ POM_ARTIFACT_ID=shadow-gradle-plugin
VERSION_NAME=9.7.0-SNAPSHOT

POM_NAME=Shadow Gradle Plugin
POM_DESCRIPTION=Gradle plugin to create fat/uber JARs, apply file transforms, and relocate packages for applications and libraries. Gradle version of Maven's Shade plugin.
POM_DESCRIPTION=Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing applications with R8/ProGuard. The Gradle counterpart to Maven's Shade plugin.
POM_INCEPTION_YEAR=2024
POM_URL=https://github.com/GradleUp/shadow

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
site_name: Shadow Gradle Plugin
repo_name: Shadow
repo_url: https://github.com/GradleUp/shadow
site_description: "Gradle plugin to create fat/uber JARs, apply file transforms, and relocate packages for applications and libraries"
site_description: "A Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing applications with R8/ProGuard. The Gradle counterpart to Maven's Shade plugin."
site_author: GradleUp developers
remote_branch: gh-pages
edit_uri: edit/main/docs
Expand Down