[MSOURCES-106] Allow inclusion of additional files like LICENSE and NOTICE in source jar

Open
#177 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
build-system

Research direction

Start by locating the source:jar, source:jar-no-fork, source:test-jar, and source:tst-jar-no-fork goals and reviewing how they assemble the source jar. Done means an optional additionalFiles parameter can include files outside the source tree, such as LICENSE and NOTICE, in the generated jar.

Written by the indexing model from the issue text.

Description

enhancement priority:major

Luc Maisonobe opened MSOURCES-106 and commented

The source jar, despite not being intended as a full-featured source distribution, can be considered a derivative work. Some licenses (like the Apache License!) require that derivative work includes copies of important legal files, like LICENSE and NOTICE in the case of the
Apache License, but there may be other cases.

Currently, there are no provisions in the source plugin to add files that are not within
the source tree. Typical Apache projects put the LICENSE and NOTICE at the top level
of the project, outside of the source tree.

It would be nice to have an optional parameter "additionnalFiles" in the various goals source:jar, source:jar-no-fork, source:test-jar, source:tst-jar-no-fork where a list of additional files could be put in the jar (putting them at the top level of the jar would probably be OK, but some other plugins put such files in the META-INF directory within the jar)

Affects: 3.0.1

Dominant language
Java
Stars
37
Forks
38
Avg merge
12h 11m
Merged PRs (30d)
6

Contributor guide

No contributing guide indexed for this repository

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.

More from apache/maven-source-plugin

All issues in apache/maven-source-plugin

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.