[MRELEASE-798] Commit additional files with release plugin

[jira-importer]

Thorsten Hoeger opened MRELEASE-798 and commented

Hi,

is there any possibility to have the release-plugin commit additional files which were
generated/modified in the preparationGoals.

Now only the pom.xml is commited. Using scm-plugin has some serious drawbacks in this
situation.

If it is not possible at the moment, is there any chance to get this in the future. Maybe
there could be a parameter additionalCommitFiles with a list of files to commit along with
pom.xml.

---

Affects: 2.3.2

Attachments:

• maven-release-2.4.1-additionalCommitted.patch (12.32 kB)

Issue Links:

• MSHADE-145 Site not generated correctly when overriding dependencyReducedPomLocation with relocation

• MRELEASE-51 release:perform could update the date attribute in the changes.xml

Remote Links:

• GitHub Pull Request #20
  
• GitHub Pull Request #4
  

7 votes, 10 watchers

[jira-importer]

Thorsten Hoeger commented

As 2.4 was announced I want to ask again if this will be implemented in the future.

[jira-importer]

Robert Scholte commented

What do you mean with "generated/modified"? Do you have concrete examples?
Somehow I expect some impact, but that should be exposed when running the release:perform.

Providing patches increases the chance to get issues resolved, especially if they contain tests.

[jira-importer]

Thorsten Hoeger commented

In my current use case, I generate the changelog in the preparationGoals section.

Now it would be nice if this changelog file would be commited to scm.

[jira-importer]

Robert Scholte commented

Ok, so it's related to MRELEASE-51, but I don't think I'll implement it as additionalCommitFiles. One idea I have is to add some kind of extension, which the release-plugin will call with specific release properties. That could return a set of files which should be added to the release.

[jira-importer]

Thorsten Hoeger commented

Hi, is there any progress planned?

[jira-importer]

Robert Scholte commented

Not yet

[jira-importer]

Emilio Jose Mena Cebrian commented

I've done a patch to version 2.4.1 to implement that using a property additionalCommittedIncludeList

I've attached the patch file.

I can generate a patch for the trunk if it's necessary

[jira-importer]

Emilio Jose Mena Cebrian commented

Patch to add files to commit additional files using a file filter

[jira-importer]

Emilio Jose Mena Cebrian commented

Added a pull request @ GitHub

[jira-importer]

Robert Scholte commented

See one of my previous comments: the solution should not be something like additionalCommitFiles, but some sort of extension where you can manipulate files. changelog is a good example, still looking for more.

[jira-importer]

Emilio Jose Mena Cebrian commented

I know it, but it's a workaround until your solution is available.
I had to implement it for my company and i thought it might help Thorsten Hoeger

A better solution might be to have a extension point to modify files and add them to the commit as you said.

So a "ModifyFilesForDevelopmentPhase" runs every extension to modify files and "register" changes to a "ChangedFilesManager"

That ChangedFilesManager might save previous version of modified files in case you have to restore them (e.g.: a rollback)

So RewritePomsForPhase classes might be a implementation of this extension and ScmCommitPhase classes might commit only files registered in "ChangedFilesManager" and not only poms.

What do you think about it?

[jira-importer]

Robert Scholte commented

Since it's a workaround I'm not going to accept the pullrequest, because these Maven plugins must stay backwards compatible. There's no such thing as a temporary workaround, but users are free to use your fork of course.
I haven't collected all the requirements, but I think your idea is indeed a good start. Very clever to think of the rollback as well.

[jira-importer]

Jari Hyle commented

Hi!

This feature would ease the use of this plugin greatly! Is there any info if and when this will be implemented?

[jira-importer]

Vivek commented

April 2021, and still waiting for this feature to be implemented. BTW, I've found many people on SO looking for the similar functionality. Below are some of the links

https://stackoverflow.com/questions/10161340/maven-release-perform-commit-additional-files

https://stackoverflow.com/questions/10583434/commit-some-files-while-maven-releaseprepare

https://stackoverflow.com/questions/48947392/commit-multiple-files-with-maven-scm-plugin

https://stackoverflow.com/questions/29702220/how-to-commit-replaced-properties-by-maven-with-release-plugin

This feature would be highly appreciated, Any updates on when this will be implemented?

[jira-importer]

Robert Scholte commented

It looks like I'm the maven-committer active on this topic and I have much bigger topics to pick up, so don't expect anything soon.
However, I think there's a way you can solve this yourself: introduce a new ReleasePhase and define your own set of release phases. Have a look at https://maarten.mulders.it/2020/01/customise-the-maven-release-process/ for some guidance.