Maven 2.x Changes Plugin

Add option to skip announcement if there are no changes or changes.xml file is missing

Details

  • Type: Improvement Improvement
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: 2.4
  • Fix Version/s: None
  • Component/s: changes.xml
  • Labels:
    None
  • Number of attachments :
    0

Description

It will be good to have some option to skip announcement generation if there are no changes for artifact. Now if there are no changes build fails with error:
No releases found in any of the configured issue management systems.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Dennis Lundberg added a comment -

Hi

How could we determine that there are no changes?
Are you using only a changes.xml file?

Show
Dennis Lundberg added a comment - Hi How could we determine that there are no changes? Are you using only a changes.xml file?
Hide
Permalink
Ivan Khalopik added a comment -

Hi,

I am using announcement-generate mojo with changes.xml to create release notes file, that will be packaged to release jar. It will be good to have one central (in parent pom) configuration for all child modules that will generate CHANGES file and put it into jar. But if there are no changes.xml file (or it is empty) in some modules the plugin will force build error. It is possible to move configuration to those modules that have changes.xml, but it is not a good solution i think.

In ChangesValidationMojo you have failOnError option. It will be nice to have similar option in AnnouncementMojo. For example:

if ( releases == null || releases.isEmpty() )
{
if (failOnError)

{ throw new MojoExecutionException( "No releases found in any of the configured issue management systems." ); }

}
else

{ doGenerate( releases ); }

Or to wrap code with try-catch as the whole execute method can provide exceptions too.

Show
Ivan Khalopik added a comment - Hi, I am using announcement-generate mojo with changes.xml to create release notes file, that will be packaged to release jar. It will be good to have one central (in parent pom) configuration for all child modules that will generate CHANGES file and put it into jar. But if there are no changes.xml file (or it is empty) in some modules the plugin will force build error. It is possible to move configuration to those modules that have changes.xml, but it is not a good solution i think. In ChangesValidationMojo you have failOnError option. It will be nice to have similar option in AnnouncementMojo. For example: if ( releases == null || releases.isEmpty() ) { if (failOnError) { throw new MojoExecutionException( "No releases found in any of the configured issue management systems." ); } } else { doGenerate( releases ); } Or to wrap code with try-catch as the whole execute method can provide exceptions too.
Hide
Permalink
Dennis Lundberg added a comment -

Hi

You can do this in other standard Maven ways:

1. Create a profile called "changes" in which you put all your configuration for generating the announcement and including it into you JAR. Activate that profile in each project that has a changes.xml file.

2. Configure maven-changes-plugin inside <pluginManagement> in your parent POM. In each project that has a changes.xml file you add maven-changes-plugin to <build> / <plugins>.

Show
Dennis Lundberg added a comment - Hi You can do this in other standard Maven ways: 1. Create a profile called "changes" in which you put all your configuration for generating the announcement and including it into you JAR. Activate that profile in each project that has a changes.xml file. 2. Configure maven-changes-plugin inside <pluginManagement> in your parent POM. In each project that has a changes.xml file you add maven-changes-plugin to <build> / <plugins>.
Hide
Permalink
Ivan Khalopik added a comment -

Yes, I can, but it is not so nice solution I think. Such option will not change plugin behavior as it can be true by default.
Also I can add that changes report mojo doesn't cause errors if there are no changes, it just logs warning and skips report generation.
Surefire plugin also did't execute any tests if there are no tests.

Show
Ivan Khalopik added a comment - Yes, I can, but it is not so nice solution I think. Such option will not change plugin behavior as it can be true by default. Also I can add that changes report mojo doesn't cause errors if there are no changes, it just logs warning and skips report generation. Surefire plugin also did't execute any tests if there are no tests.
Hide
Permalink
Louis Jacomet added a comment -

Hi,

We are facing a similar issue on my current project. We are using the changes plugin and Jira, generating announcements.
We want to generate an announcement for every build we do on the continuous integration server. But we do not want to have a build fail because there is no issue with a configured status associated with the release. As indeed the plugin fails not because the release does not exist in Jira, just that no issue matching the criteria (fixVersion and status) refers to the specific release. Which makes supporting the SNAPSHOT qualifier weird, as when a new SNAPSHOT version is created it might not have any solved release immediately.

In order to solve the issue, I am modifying the plugin to support an attribute "allowEmptyAnnouncement". Based on this attribute, I intend to have the ReleaseUtils.getLatestRelease either throw the exception, or create an empty release with no actions associated.

I intend to post the diff once done and tested. However, I did not consider the other possible usage of this plugin, so the solution will be partial.

Show
Louis Jacomet added a comment - Hi, We are facing a similar issue on my current project. We are using the changes plugin and Jira, generating announcements. We want to generate an announcement for every build we do on the continuous integration server. But we do not want to have a build fail because there is no issue with a configured status associated with the release. As indeed the plugin fails not because the release does not exist in Jira, just that no issue matching the criteria (fixVersion and status) refers to the specific release. Which makes supporting the SNAPSHOT qualifier weird, as when a new SNAPSHOT version is created it might not have any solved release immediately. In order to solve the issue, I am modifying the plugin to support an attribute "allowEmptyAnnouncement". Based on this attribute, I intend to have the ReleaseUtils.getLatestRelease either throw the exception, or create an empty release with no actions associated. I intend to post the diff once done and tested. However, I did not consider the other possible usage of this plugin, so the solution will be partial.

People

  • Assignee:
    Unassigned
    Reporter:
    Ivan Khalopik
Vote (1)
Watch (2)

Dates

  • Created:
    Updated: