Automatically filter additional-spring-configuration-metadata.json from Spring Boot-built archives #27430

Activity

1. spring-projects-issues

   added

   status: waiting-for-triageAn issue that has not yet been triaged. Contributions will not be accepted.An issue that has not yet been triaged. Contributions will not be accepted.

   on Jul 21, 2021
2. bclozel commented on Jul 21, 2021

   

   bclozel

   on Jul 21, 2021

   Member

   More actions

   This file is packaged with your project to provide additional information to developers when working with your library, as explained in our reference documentation.

   Not packaging it with the library would make that file useless.
3. bclozel

   closed this as completedon Jul 21, 2021
4. bclozel

   added

   status: declinedA suggestion or change that we don't feel we should currently applyA suggestion or change that we don't feel we should currently apply

   and removed

   status: waiting-for-triageAn issue that has not yet been triaged. Contributions will not be accepted.An issue that has not yet been triaged. Contributions will not be accepted.

   on Jul 21, 2021
5. bclozel commented on Jul 21, 2021

   

   bclozel

   on Jul 21, 2021

   Member

   More actions

   @wilkinsona pointed out that this information is indeed merged in the main metadata file.

   I’m not sure how we can prevent this file from being packaged with the library. Is there anything we can do here? Maybe document how to filter out this file in the build?
6. bclozel

   reopened this on Jul 21, 2021
7. bclozel

   added

   status: waiting-for-triageAn issue that has not yet been triaged. Contributions will not be accepted.An issue that has not yet been triaged. Contributions will not be accepted.

   and removed

   status: declinedA suggestion or change that we don't feel we should currently applyA suggestion or change that we don't feel we should currently apply

   on Jul 21, 2021
8. wangliang181230 commented on Jul 22, 2021

   

   wangliang181230

   on Jul 22, 2021

   Last edited by wangliang181230

   Author

   More actions

   Can put the additional-spring-configuration-metadata.json in the src/main/xxx directory? Not the /src/main/resources/META-INF directory.
9. wangliang181230 commented on Jul 22, 2021

   

   wangliang181230

   on Jul 22, 2021

   Last edited by wangliang181230

   Author

   More actions

   Outside the /src/main/resources directory, I think it will not be packaged into the library.
10. wangliang181230

    changed the title [-]remove `additional-spring-configuration-metadata.json` from the jar of the spring-boot application[/-] [+]Remove `additional-spring-configuration-metadata.json` from the jar[/+] on Jul 22, 2021
11. bclozel commented on Jul 22, 2021

    

    bclozel

    on Jul 22, 2021

    Member

    More actions

    I'm not sure the annotation processor will be able to find these files if they're not shipped as resources.
12. wangliang181230 commented on Jul 22, 2021

    

    wangliang181230

    on Jul 22, 2021

    Last edited by wangliang181230

    Author

    More actions

    Can the Maven plugin merge the metadata?
13. wangliang181230 commented on Jul 23, 2021

    

    wangliang181230

    on Jul 23, 2021

    Last edited by wangliang181230

    Author

    More actions

    @bclozel The maven-jar-plugin can exclude additional, and is merged to the main metadata.

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <excludes>
                        <exclude>**/META-INF/additional-spring-configuration-metadata.json</exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
    

    
14. 2 remaining items

    Load more

15. wilkinsona commented on Jul 26, 2021

    

    wilkinsona

    on Jul 26, 2021

    Last edited by wilkinsona

    Member

    More actions

    I think it would be nice to avoid bundling the additional metadata file by default if we can.

    It would be straightforward in our own build, but I'm not sure it's possible to do it automatically for users while using a location beneath src/main/resources. They could be building a shared module without our Maven or Gradle plugins so we don't have a chance to filter things.

    The only other option that I can think of is to use a location outside src/main/resources for the metadata as suggested above. I wonder about the additional complexity of this, though, and the possible impact on up-to-date checks and incremental compilation with Gradle.
16. wilkinsona commented on Jul 26, 2021

    

    wilkinsona

    on Jul 26, 2021

    Member

    More actions

    We're going to update the Maven and Gradle plugins to filter out the file automatically. We'll also update the documentation to suggest that anyone building a library without our plugins configures their build to do the same.

    👍React with 👍1Reacted by 王良
17. wilkinsona

    changed the title [-]Remove `additional-spring-configuration-metadata.json` from the jar[/-] [+]Automatically filter `additional-spring-configuration-metadata.json` from Spring Boot-built archives[/+] on Jul 26, 2021
18. wilkinsona

    added

    type: enhancementA general enhancementA general enhancement

    and removed

    for: team-attentionAn issue we'd like other members of the team to reviewAn issue we'd like other members of the team to review

    status: waiting-for-triageAn issue that has not yet been triaged. Contributions will not be accepted.An issue that has not yet been triaged. Contributions will not be accepted.

    on Jul 26, 2021
19. wilkinsona

    added this to the 2.x milestone on Jul 26, 2021
20. philwebb

    modified the milestones: 2.x, 3.x on Aug 19, 2022
21. wilkinsona

    modified the milestones: 3.x, 4.x on Dec 10, 2025
22. wilkinsona commented on Sep 3, 2026

    

    wilkinsona

    on Sep 3, 2026

    Member

    More actions

    Closing in favor of #51386.
23. wilkinsona

    closed this as duplicateon Sep 3, 2026
24. wilkinsona

    added

    status: supersededAn issue that has been superseded by anotherAn issue that has been superseded by another

    on Sep 3, 2026
25. wilkinsona

    removed this from the 4.x milestone on Sep 3, 2026