GradleUp / GradleUp/shadow

Creating a source jar reflecting the "uber jar"

Open
#41 15 comments 20 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Kotlin
Stars
4.2k
Forks
425
Avg merge
3h 52m
Merged PRs (30d)
88

Description

Is it possible to use the Shadow plugin to create a source code and maybe even a javadoc jar that reflects the state after "merging"?

I need to import ASM in my project, i.e. the original packaging cannot be used for anything since this would violate compatibility. However, if someone added a dependency to my project, they could not navigate the dependency or read any documentation since the uber jar does not come with such information.

If this is not yet possible, is it consider to implement such functionality? I really need it and I want to move a first release to Maven Central soon, so I would be more than greatful. Great plugin, by the way, even without that feature!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names Shadow's uber-jar packaging but no files or tests. Start by locating the existing jar merge and relocation entry point, then inspect how source and Javadoc artifacts are handled. Done means producing source and optionally Javadoc jars whose contents reflect the merged uber jar and can be published with it.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, kotlin
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.