gradle 8

galasa-dev · Aug 6, 2024 · 22c9ec5 · 22c9ec5
1 parent af78369
commit 22c9ec5
Show file tree

Hide file tree

Showing 4 changed files with 106 additions and 14 deletions.
diff --git a/src/markdown-pages/docs/cli-command-reference/cli-prereqs.md b/src/markdown-pages/docs/cli-command-reference/cli-prereqs.md
@@ -6,13 +6,39 @@ title: "CLI prerequisites online"
 
 The following section explains more about the software prerequisites that you need so that you are ready to install Galasa from the Galasa CLI repository in GitHub.
 
-## Prerequisites
 
-| Software |  Description  |
+### Java JDK 
+
+Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 17 or later. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.
+
+
+### Maven 
+
+You must install either Maven or Gradle in order to build Galasa projects, which are hierarchical file structures that provide the ability to store and run Galasa tests.  
+
+### Gradle
+
+You must install either Maven or Gradle in order to build Galasa projects, which are hierarchical file structures that provide the ability to store and run Galasa tests. 
+
+The following table shows the current compatibility between Gradle and Galasa versions: 
+
+
+| Gradle release |  Compatible Galasa version  |
 | :---- | :-------- | 
-| Java JDK  | Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 17 or later. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.|
-| Maven or Gradle  | You must install either Maven or Gradle in order to build Galasa projects. Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests. All Galasa versions are compatible with Gradle releases 6.9.x. Remember to add Gradle to your Path. You can check by running `echo $PATH` on Mac or Unix, or `echo %PATH%` on Windows (PowerShell). |
-| 3270 emulator | Optional. Although you do not need a 3270 emulator to run a Galasa test (even if it tests a 3270 application) you can use one to [run Galasa Simbank online](../running-simbank-tests/simbank-cli), a simulated version of an application that helps you get acquainted with Galasa before connecting to a real mainframe to run your own tests. There are many such emulators available but IBM's Personal Communications (PCOMM) is frequently used, as is IBM's Host on Demand software, which includes support for Windows, Linux and MacOS.| 
+| 6.8.x  | All |
+| 6.9.x  | All |
+| 7.x.x | All | 
+| 8.x.x | 0.36.0 |
+
+
+Remember to add Gradle to your PATH. You can check by running `echo $PATH` on Mac or Unix, or `echo %PATH%` on Windows (PowerShell).
+
+If you are upgrading to Gradle version 8 from an earlier version, see the `Upgrading tests to compile using Gradle version 8` section in the [Upgrading](../upgrading) documentation to understand the changes you need to make to create Galasa projects and build and compile Galasa test code. 
+
+
+### 3270 emulator 
+
+Optional. Although you do not need a 3270 emulator to run a Galasa test (even if it tests a 3270 application) you can use one to [run Galasa Simbank online](../running-simbank-tests/simbank-cli), a simulated version of an application that helps you get acquainted with Galasa before connecting to a real mainframe to run your own tests. There are many such emulators available but IBM's Personal Communications (PCOMM) is frequently used, as is IBM's Host on Demand software, which includes support for Windows, Linux and MacOS.
 
 
 ## Next steps

diff --git a/src/markdown-pages/docs/cli-command-reference/zipped-prerequisites.md b/src/markdown-pages/docs/cli-command-reference/zipped-prerequisites.md
@@ -7,17 +7,42 @@ title: "CLI prerequisites offline"
 The following section explains more about the software prerequisites that you need to install so that you are ready to install the zipped distribution for Galasa for running offline.
 
 
-## Prerequisites
+### Java JDK 
 
+Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 17 or later. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation.
 
-| Software |  Description  |
+### Gradle
+
+Required to install the offline zipped distribution. You can also build Galasa projects using Gradle. (You can build projects using Maven if you prefer). Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests.
+
+The following table shows the current compatibility between Gradle and Galasa versions: 
+
+
+| Gradle release |  Compatible Galasa version  |
 | :---- | :-------- | 
-| Java JDK  | Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 17 or later. After installing, you must set the `JAVA_HOME` environment variable to your Java JDK installation path and check it set successfully by running the command `echo $JAVA_HOME` on Mac or Unix, or `echo %JAVA_HOME%` on Windows (PowerShell). The returned result shows the path to your JDK installation. |
-| Gradle  | Required to install the zipped distribution. You can also build Galasa projects using Gradle. (You can build projects using Maven if you prefer). Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests. All Galasa versions are compatible with Gradle releases 6.9.x.|
-| Maven  | You must install either Maven or Gradle in order to build Galasa projects. Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests. You do not explicitly need to install Maven because the Galasa plugin downloads and installs it silently during its own installation and configuration. |
-| Docker  | Required if using the Docker image. If you want to deploy the Docker image that is provided in the zip file, you will need to have Docker installed.  |
-| 3270 emulator | Optional. Although you do not need a 3270 emulator to run a Galasa test (even if it tests a 3270 application) you can use one to [run Galasa Simbank offline](../running-simbank-tests/simbank-cli-offline), a simulated version of an application that helps you get acquainted with Galasa before connecting to a real mainframe to run your own tests. There are many such emulators available but IBM's Personal Communications (PCOMM) is frequently used, as is IBM's Host on Demand software, which includes support for Windows, Linux and MacOS.| 
+| 6.8.x  | All |
+| 6.9.x  | All |
+| 7.x.x | All | 
+| 8.x.x | 0.36.0 |
+
+Remember to add Gradle to your PATH. You can check by running `echo $PATH` on Mac or Unix, or `echo %PATH%` on Windows (PowerShell).
+
+If you are upgrading to Gradle version 8 from an earlier version, see the `Upgrading tests to compile using Gradle version 8` section in the [Upgrading](../upgrading) documentation to understand the changes you need to make to create Galasa projects and build and compile Galasa test code. 
+
+
+
+### Maven 
+
+You must install either Maven or Gradle in order to build Galasa projects, which are hierarchical file structures that provide the ability to store and run Galasa tests.  
+
+
+### Docker
+
+Required if using the Docker image. If you want to deploy the Docker image that is provided in the zip file, you will need to have Docker installed.
+
+### 3270 emulator 
 
+Optional. Although you do not need a 3270 emulator to run a Galasa test (even if it tests a 3270 application) you can use one to [run Galasa Simbank online](../running-simbank-tests/simbank-cli), a simulated version of an application that helps you get acquainted with Galasa before connecting to a real mainframe to run your own tests. There are many such emulators available but IBM's Personal Communications (PCOMM) is frequently used, as is IBM's Host on Demand software, which includes support for Windows, Linux and MacOS.
 
 
 ## Next steps

diff --git a/src/markdown-pages/docs/upgrading.md b/src/markdown-pages/docs/upgrading.md
@@ -5,7 +5,7 @@ title: "Upgrading"
 
 ## Upgrading (online)
 
-You can get the upgrade your version of Galasa by completing the following steps:
+You can upgrade your version of Galasa by completing the following steps:
 
 1. Download the appropriate version of the Galasa CLI for your machine architecture from the <a href="https://github.com/galasa-dev/cli/releases" target="_blank"> Galasa CLI repository</a> in GitHub.
 2. Re-name the your existing `galasactl` binary so that you can re-name the Galasa binary that you just downloaded to `galasactl` to replace it. 
@@ -19,6 +19,38 @@ If you have already added the Galasa CLI path to your shell's initialization fil
 Download and extract the Galasa zip file to a directory of your choice and complete the steps documented in the [Installing the Galasa CLI offline](../docs/cli-command-reference/installing-offline) topic.
 
 
+## Upgrading tests to compile using Gradle version 8 
+
+Galasa releases 0.35.0 and earlier supported the use of Gradle versions 6.8.x, 6.9.x, and 7.x.x to create Galasa projects and build Galasa test code. From release 0.36.0 and later, Galasa additionally supports the use of Gradle version 8.x.x. 
+
+To use Gradle version 8.0 or later to create Galasa projects and build and compile Galasa test code, complete the following steps:
+
+1. Edit the `build.gradle` file in the OBR directory of your parent project, setting the plug-in values at the top of the file to version `0.36.0`, as shown in the following example:
+```
+plugins {
+...
+id 'dev.galasa.obr' version '0.36.0'
+id 'dev.galasa.testcatalog' version '0.36.0'
+...
+}
+```
+2. Add the following task definition to the `build.gradle` file in the OBR directory of the parent project to ensure that Gradle uses the correct build order.
+
+```groovy
+tasks.withType(PublishToMavenLocal) { task ->
+    task.dependsOn genobr
+    task.dependsOn mergetestcat
+}
+```
+3. In each test project `build.gradle` file, set the `dev.galasa.tests` plug-in to version `0.36.0` to ensure that the build uses the correct plug-in.
+```
+plugins {
+...
+id 'dev.galasa.tests' version '0.36.0'
+...
+}
+```
+
 
 ## Upgrading from using Eclipse to using the command line (online)
 

diff --git a/src/markdown-pages/highlights.md b/src/markdown-pages/highlights.md
@@ -17,9 +17,18 @@ We have the following available Slack channels:
 
 Access the Galasa source code in [GitHub](https://github.com/galasa-dev) and open issues in the [project management repository](https://github.com/galasa-dev/projectmanagement).
 
-## 0.35.0 - Release Highlights
+
+## 0.36.0 - Release Highlights
+
+- You can now create Galasa projects and build and compile Galasa test code using Gradle version 8. For more information, see the `Upgrading tests to compile using Gradle version 8` section in the [Upgrading](docs/upgrading) documentation to understand the changes you need to make.
+
+- Various documentation updates
+
+<details>
+<summary><b>0.35.0 - Release Highlights</b></summary>
 
 - A fix to the database connector of the DB2 Manager
+</details> 
 
 
 <details>