Add migration notice to README (#112)

* Add migration notice to README * Apply suggestions from code review Co-authored-by: Guy Brand <[email protected]> Signed-off-by: Iurii Ignatko <[email protected]> --------- Signed-off-by: Iurii Ignatko <[email protected]> Co-authored-by: Guy Brand <[email protected]>
gradle · Feb 19, 2024 · 8e351a4 · 8e351a4
1 parent 1910c26
commit 8e351a4
Showing 1 changed file with 16 additions and 2 deletions.
diff --git a/README.adoc b/README.adoc
@@ -3,6 +3,21 @@
 
 = Develocity Bamboo plugin
 
+== Migration Notice
+
+As of version `1.3.0`, the plugin contains the renaming from Gradle Enterprise to Develocity. However, it was still available under the same Maven coordinates.
+Version `2.0.0` updates that to `com.gradle.develocity:develocity-bamboo-plugin`. It also contains several internal changes that make it backward incompatible with `1.3.0`.
+
+Additionally, starting from `2.0.0`, the plugin is no longer available via https://marketplace.atlassian.com/apps/1230500/develocity-plugin-for-bamboo[Atlassian Marketplace] due to
+https://www.atlassian.com/migration/assess/journey-to-cloud[Atlassian's migration to the Cloud].
+
+To upgrade from `1.3.0` to `2.0.0` follow these steps:
+
+1. Take note of the current configuration settings, as after the upgrade, the plugin will need to be configured again.
+2. Uninstall the app via the `Manage Apps` section on the Bamboo Administration page.
+3. Install the new version as mentioned https://confluence.atlassian.com/bamboo/installing-a-plugin-289277265.html[here].
+4. Configure the plugin again using the configuration settings from step #1.
+
 == Overview
 
 This plugin integrates with Develocity for Gradle and Maven builds run via Bamboo.
@@ -15,8 +30,7 @@ image::build-scan-links.png[Build Scan Links,{thumbnail}]
 
 == Installation
 
-The plugin is available via https://marketplace.atlassian.com/apps/1230500/develocity-plugin-for-bamboo[Atlassian Marketplace].
-It is also possible to install the plugin manually as mentioned in https://confluence.atlassian.com/bamboo/installing-a-plugin-289277265.html[Uploading your own plugin] section. The released JARs can be found in the Releases.
+The plugin can be manually installed as mentioned in https://confluence.atlassian.com/bamboo/installing-a-plugin-289277265.html[Uploading your own plugin] section. The released JARs can be found at https://github.com/gradle/develocity-bamboo-plugin/releases[Releases].
 
 Once the plugin is installed, the Bamboo Administration page will have a new section available under the “Managed Apps” group named Develocity integration.