[MRELEASE-955] Document how to work with release profile in 3.x vs 2.x

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.0.0-M1, 3.0.0-M5
• Fix Version/s: 3.0.0-M6
• Component/s: documentation
• Environment: n/a
• Assignee: Herve Boutemy
• Reporter: Anders Hammar
• Created: 14/Jun/16 10:44
• Updated: 22/May/22 23:08
• Resolved: 08/May/22 09:36

Description

In v3.0.0 of the plugin, the useReleaseProfile parameter has been deprecated and default value changed to false.

This effectively changes from convention over configuration with a default release profile (the release-profile profile in the super-POM) so that the end user now needs:
1. to create a release profile (with his own naming choice)
2. and configure the plugin to use it (like add <arguments>-Pname_of_the_release_profile ...</arguments> or <releaseProfiles>name_of_the_release_profile</releaseProfiles>).

We need to document this change in behavior as well as describe best-practice for handling this.

Issue Links

• is related to: MRELEASE-896 Disable by default and deprecate useReleaseProfile parameter
• is related to: MRELEASE-973 Please keep the property performRelease or provide an alternative for it
• relates to: MNG-7029 Remove super POM "release-profile" release profile
• links to: GitHub Pull Request #110