Include all source artifacts in published sources jars [SPR-12085]

[spring-projects-issues]

Sam Brannen opened SPR-12085 and commented

Status Quo

For example, in 4.1 RC2, the META-INF/spring.factories file is present in spring-test-4.1.0.RC2.jar, but it is not present in spring-test-4.1.0.RC2-sources.jar. The same is true for the spring-beans module.

Further analysis reveals that only Java and AspectJ source code are included in the current 'sources' jars.

Deliverables

1. Ensure that META-INF/spring.factories is included in published 'sources' archives across the framework.
   • This currently is known to affect spring-beans and spring-test.
2. Ensure that the following file types are also included in published 'sources' archives:
   • Groovy source code
   • Properties files
   • XML files
   • META-INF/services/*
   • mime.types

---

Affects: 3.2.10, 4.0.6, 4.1 RC2

Issue Links:

• Include Groovy source code in published sources jars [SPR-12086] #16702 Include Groovy source code in published sources jars ("is depended on by")
• Include Groovy source code in published sources jars [SPR-12086] #16702 Include Groovy source code in published sources jars ("supersedes")

Backported to: 4.0.7, 3.2.11

[spring-projects-issues]

Sam Brannen commented

Fixed as described in the comments for GitHub commit 9ea646e:

Include all source artifacts in published sources jars

This commit updates the Gradle build to ensure that the following are
including in published 'sources' jars.

• Java source code (previously supported)
• AspectJ source code (previously supported)
• META-INF/spring.factories
• META-INF/services/*
• Java Properties files
• XML files
• MIME types files (mime.types)

[spring-projects-issues]

Sam Brannen commented

FYI: I opened #16702 to address the outstanding issue regarding Groovy source code.

[spring-projects-issues]

Sam Brannen commented

Reopened for backporting.

[spring-projects-issues]

Stéphane Nicoll commented

Is there a reason to do that with a lengthy list of includes vs. a smart exclude? What files could be present in src/main/xyz that we do not want in the generated source archive exactly?

[spring-projects-issues]

Sam Brannen commented

That's a valid question. To be honest, the current style of explicitly including things is simply based on the "status quo" (i.e., how it was done in the past).

As for what could possibly be present in src/main/\* that we wouldn't want in the sources JARs, I don't know. I just looked, and I can't foresee anything causing any issues. So I'll simplify the current configuration in build.gradle and just include everything by default.

Cheers,

Sam

[spring-projects-issues]

Sam Brannen commented

This issue has been addressed as described in the comments for GitHub commits 07629a3 (4.1.0), a52ff46 (4.0.7), and 3b64db1 (3.2.11):

Include ALL source artifacts in published sources jars

This commit updates the Gradle build to ensure that all source
artifacts are including in published 'sources' jars.

To achieve this, we are now assembling 'sources' jars from
'sourceSets.main.allSource' and not explicitly including or excluding
anything by default.