What is "the special marker" in `ivy.xml` files?

Martin_d_Anjou · June 27, 2023, 2:43pm

… Gradle will first look for an ivy.xml file, but if this file contains a special marker …

What is the special marker exactly?

Vampire · June 27, 2023, 4:03pm

gradle/gradle/blob/master/subprojects/dependency-management/src/main/java/org/gradle/api/internal/artifacts/ivyservice/ivyresolve/parser/MetaDataParser.java#L38


      
          String GRADLE_METADATA_MARKER = "do-not-remove: published-with-gradle-metadata";
          /**
           * If the following marker is found in a `pom` file, Gradle (version 6.0 or higher)
           * will look for a `module` file to use it instead of the `pom` file.
           * This marker was introduced to allow library authors to publish Gradle Module Metadata
           * for Gradle 6+ consumers only. Wider adoption of the format only starts with Gradle 6.
           * There were some semantic changes and fixes with 6.0 in `module` metadata interpretation.
           * These can break certain 5.x users in unexpected ways when consuming a library that
           * moved from publishing `pom` only to also publish `module` files.
           */
          String GRADLE_6_METADATA_MARKER = "do_not_remove: published-with-gradle-metadata";
          String[] GRADLE_METADATA_MARKER_COMMENT_LINES = {
                  "This module was also published with a richer model, Gradle metadata, ",
                  "which should be used instead. Do not delete the following line which ",
                  "is to indicate to Gradle or any Gradle module metadata file consumer ",
                  "that they should prefer consuming it instead."};
          
          ParseResult<T> parseMetaData(DescriptorParseContext context, LocallyAvailableExternalResource resource) throws MetaDataParseException;
          
          ParseResult<T> parseMetaData(DescriptorParseContext context, File descriptorFile) throws MetaDataParseException;