Skip to content

wrapperVersion property gets removed when upgrading to Maven Wrapper 3.3.3 #364

Closed
Closed
wrapperVersion property gets removed when upgrading to Maven Wrapper 3.3.3#364
Labels
bugSomething isn't workingpriority:criticalCrashes, loss of data, severe memory leak
Milestone
3.3.4

Description

@breun
breun
opened on Aug 31, 2025

Affected version

3.3.3

Bug description

When I install a newer version of Maven Wrapper, wrapperVersion is removed from .mvn/wrapper/maven-wrapper.properties.

To reproduce (using Maven 3.9.11 as mvn):

mkdir reproducer
cd reproducer

# Install Maven Wrapper 3.3.2
mvn wrapper:3.3.2:wrapper -Dmaven=3.9.11

# This show `wrapperVersion=3.3.2`
grep wrapperVersion .mvn/wrapper/maven-wrapper.properties

# Update to Maven Wrapper 3.3.3
./mvnw wrapper:3.3.3:wrapper

# This returns nothing, because wrapperVersion has been removed, which I don't expect to happen
grep wrapperVersion .mvn/wrapper/maven-wrapper.properties

Note: previously this description also mentioned distributionSha256Sum getting removed during a Maven Wrapper update. I've split this off to its own issue: #367

Activity

  1. breun
    added
    bugSomething isn't working
    on Aug 31, 2025

  2. slawekjaranowski commented on Sep 2, 2025

    @slawekjaranowski
    slawekjaranowski
    on Sep 2, 2025
    Member

    done in:

  3. slawekjaranowski
    added this to the 3.3.4 milestone on Sep 2, 2025

  4. slawekjaranowski commented on Sep 2, 2025

    @slawekjaranowski
    slawekjaranowski
    on Sep 2, 2025
    Member

    in order to preserver distributionSha256Sum we should read existing properties

  5. breun commented on Sep 2, 2025

    @breun
    breun
    on Sep 2, 2025
    ContributorAuthor

    done in:

    Update automation tools (and humans too, I guess) need a reliable way to determine the current version of Maven Wrapper. The wrapperVersion property was a way, although admittedly flawed, because I encounter a lot of projects with wrapperVersion bumped manually, but the mvnw* scripts from a much older version, because they were not updated along with the property.

    I saw that Renovate plans to determine the Maven Wrapper version based on a regex check on the scripts themselves (renovatebot/renovate#37779), which when matched should be more reliable than reading wrapperVersion. But the regex check will only work as long as the format of the comment line it’s parsed from doesn’t change, so it’s still a fragile method.

    Could Maven Wrapper provide its version in a more robust (machine-readable) way?

  6. GreyTeardrop commented on Sep 2, 2025

    @GreyTeardrop
    GreyTeardrop
    on Sep 2, 2025

    Reposting some context: the wrapperVersion property was added in scope of MWRAPPER-134 by #135.

  7. breun commented on Sep 2, 2025

    @breun
    breun
    on Sep 2, 2025
    ContributorAuthor

    @slawekjaranowski It seems this issue is now about two things:

    • distributionSha256Sum getting removed when updating, which you already committed a fix for.
    • wrapperVersion getting removed when updating, which was done somewhat intentionally, but maybe without regard for the fact that it was used as a way (but maybe not the best or most robust way, because not all users seem to understand that it was basically a ‘read-only’ property) for tools and people to determine the Maven Wrapper version used by a project, and the discussion on how to best deal with that.

    I think it might be good to have separate issues for these two different concerns?

  8. slawekjaranowski commented on Sep 2, 2025

    @slawekjaranowski
    slawekjaranowski
    on Sep 2, 2025
    Member

    @slawekjaranowski It seems this issue is now about two things:

    • distributionSha256Sum getting removed when updating, which you already committed a fix for.
    • wrapperVersion getting removed when updating, which was done somewhat intentionally, but maybe without regard for the fact that it was used as a way (but maybe not the best or most robust way, because not all users seem to understand that it was basically a ‘read-only’ property) for tools and people to determine the Maven Wrapper version used by a project, and the discussion on how to best deal with that.

    I think it might be good to have separate issues for these two different concerns?

    exactly, PR are welcome ....

    Please let me know if someone would to work on it.

    I can release next version at next week 😄

  9. slawekjaranowski
    added
    priority:criticalCrashes, loss of data, severe memory leak
    on Sep 2, 2025

  10. breun commented on Sep 2, 2025

    @breun
    breun
    on Sep 2, 2025
    ContributorAuthor

    @slawekjaranowski I think for now #145 should just be reverted, because wrapperVersion was explicitly introduced as a way to determine the Maven Wrapper version (#249), and removing it has now broken update workflows. Do you agree?

  11. breun
    changed the title [-]Some properties get removed when upgrading[/-] [+]`wrapperVersion` and `distributionSha256Sum` properties get removed when upgrading to Maven Wrapper 3.3.3[/+] on Sep 2, 2025

  12. slawekjaranowski commented on Sep 2, 2025

    @slawekjaranowski
    slawekjaranowski
    on Sep 2, 2025
    Member

    @slawekjaranowski I think for now #145 should just be reverted, because wrapperVersion was explicitly introduced as a way to determine the Maven Wrapper version (#249), and removing it has now broken update workflows. Do you agree?

    we can simply revert #145 - in one exclusions - I would like to preserve assertions for missing wrapperUrl

  13. breun commented on Sep 2, 2025

    @breun
    breun
    on Sep 2, 2025
    ContributorAuthor

    @slawekjaranowski I think you mean like this?

  14. breun commented on Sep 4, 2025

    @breun
    breun
    on Sep 4, 2025
    ContributorAuthor

    @slawekjaranowski I see the PR for wrapperVersion has been merged, and you previously committed a fix for distributionSha256Sum, so I believe this issue can be closed. Agreed?

  15. breun
    changed the title [-]`wrapperVersion` and `distributionSha256Sum` properties get removed when upgrading to Maven Wrapper 3.3.3[/-] [+]`wrapperVersion` property gets removed when upgrading to Maven Wrapper 3.3.3[/+] on Sep 4, 2025

  16. breun commented on Sep 4, 2025

    @breun
    breun
    on Sep 4, 2025
    ContributorAuthor

    in order to preserver distributionSha256Sum we should read existing properties

    I've created a separate issue for the removal of distributionSha256Sum during a Maven Wrapper update, because I believe it warrants a separate discussion: #367

  17. slawekjaranowski commented on Sep 4, 2025

    @slawekjaranowski
    slawekjaranowski
    on Sep 4, 2025
    Member

    @slawekjaranowski I see the PR for wrapperVersion has been merged, and you previously committed a fix for distributionSha256Sum, so I believe this issue can be closed. Agreed?

    as we have separate issue for distributionSha256Sum we can close it

  18. breun
    closed this as completedon Sep 4, 2025
  19. dapete42
    added 3 commits that reference this issue on Sep 12, 2025

    Maven Wrapper: restore wrapperVersion (required for Renovate)

    a86a158

    Maven Wrapper: restore wrapperVersion (required for Renovate)

    e9221c4

    Maven Wrapper: restore wrapperVersion (required for Renovate)

    90265cf
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingpriority:criticalCrashes, loss of data, severe memory leak

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions