[MBUILDCACHE-73] Add project version as additional property for reconcilation

[jira-importer]

Patrik Dudits opened MBUILDCACHE-73 and commented

Certain plugins or goals might require to run when project version changes regardless of other inputs. A typical example would be deploy:deploy or in my specific case docker:build - It is OK to reuse the build artifact, but if version changed, I do want to upload it.

Currently only way to achieve that is  to put the goal into runAlways section. But that results in needles snapshots to be deployed or docker images being built even if there's no relevant change.

The reconcile section allows to specify properties for futher fine tuning the input. These are limited to goal parameters, and neither of my examples contain project version as a parameter, both use project model to fetch it.

Proposal would be to extend tag reconcile either with:

• special magic name project.version to include version tracking, so this could be achieved by <reconcile propertyName="project.version"/>
• attribute {}expression{}, to achieve the result with <reconcile propertyName="version" expression="${project.version}"/>
• interpolating defaultValue attribute

The second form would be preferrable as it has much larger scale of application, I can imagine putting base docker image digests in environment variable to invalidate builds when base tag gets updated. It is also more discoverable than third option.

---

Affects: 1.0.1

Issue Links:

• MBUILDCACHE-81 Add an option to include project version as part of the cache hash key
  ("duplicates")
• MBUILDCACHE-76 pom project version change not detected
  ("is duplicated by")

1 votes, 4 watchers

[jira-importer]

Olivier Lamy commented

ideally we could simply add the project.version part of the checksum calculation

[jira-importer]

Olivier Lamy commented

PR available here #117
please let us know if this help your use case.

[jira-importer]

Patrik Dudits commented

It's bittersweet solution – it definitely helps this case, it definitely is better default setting with less surprises (as forcing install and deploy is not necessary), but I will miss the behavior of not running 1 hour of integration tests in the project when only thing that changes is version from x.y.0 to {}x.y.1-SNAPSHOT{}.

I'd really welcome if there would be a way to fine tune this.

[jira-importer]

Olivier Lamy commented

Patrik Dudits but this will run only once :)
TBH this is the simple (and natural) solution for this.
Maven is always based on gav so why not here as well :)

[jira-importer]

Patrik Dudits commented

TBH this is the simple (and natural) solution for this.

I agree that that's simple and obvious solution.
 

Maven is always based on gav so why not here as well
Because then it is not possible to utilize cache to improve natural Maven release flow, which has always been bit wasteful. Especially since my project is bit on the larger side, and has quite long integration test phase. Let's compare the current and future situation:

Action	Cache without version	Cache with version
1.0-SNAPSHOT, release:prepare	Cache utilized	version changes during prepare, no cache, Full 1h build
1.0, release:perform	Full 1h build, because I turn off cache for release builds	Full Build
1.1-SNAPSHOT, regular build	Cache utilized (but misses deploy)	Full Build
So with version being part of has I will get 2 extra full builds, going from 1 hour to 3 hours build time. That's why the proposed solution doesn't make me happy, even if it is appropriate. I'd rather have it optional (but turned on by default).
There are some other cases when I would still welcome reconcilation expression. One of them would be that I want to rebuild docker image whenever base image changes. I can run a script before the build to extract current tag of base images and export them in environment. I would then want this environment value to drive whether I want to execute docker:build.

[jira-importer]

Olivier Lamy commented

simply skip test during release:prepare or perform or even both (as your build has already been validated by a CI?)
regarding your line 1.1-SNAPSHOT, regular build , cache with version Full Build. Really?? I guess only once after version change or any source change

[jira-importer]

Patrik Dudits commented

I was describing the three builds around maven release, so yes you've understood it right, only once after version change. I just liked the elegance of cache handling it instead.

So to summarize:

• I agree, that making version part of hash is good default
• I'm not very happy it's would not be configurable (but the default will likely make more people happy)
• There are still usecases of invalidating plugin execution based on properties (that are not necessarily project.version) that are not their parameters, so the extension of reconcilation is still an useful idea.

[jira-importer]

Olivier Lamy commented

the PR of the linked issue has been merged.
this doesn't fix exactly the title of this issue but could be closed as well.

[jira-importer]

Xaver commented

Hi there,
V1.0.1 works awesome (we use it in a large multi module project and reduced computation costs of CI/CD by ~80%)! Thanks a lot for it.

I think that the merge of PR#117 / MBUILDCACHE-76 was a mistake.

Please look at the description of the extension:

Version normalization supports project *version agnostic caches*

Have a look at the code:
https://github.com/apache/maven-build-cache-extension/blob/maven-build-cache-extension-1.1.0/src/main/java/org/apache/maven/buildcache/DefaultNormalizedModelProvider.java#L81-L82
The version is explicitly removed to achieve the version agnostic cache

// does not make sense to add project version to calculate hash
resultModel.setVersion(NORMALIZED_VERSION);

Other modern build tools I know (e.g. gradle, nx.dev) use version agnostic caches. I really missed this feature a lot.

Please don't close this issue. It's important for many use cases that the version is optional for checksum calculation.

Thank you from a happy 1.0.1 user.

[jira-importer]

Xaver commented

I think this Issue may be closed. With MBUILDCACHE-81 / #129 the calculateProjectVersionChecksum attribute was added

[jira-importer]

Patrik Dudits commented

Yes, the issue with project.version is solved. However I'd rather extend title to be able to use arbitrary expression in reconcilation. Or do I create a new one?