From 7c799e98376ebc95c0b72897c92b56cd2d5bfc63 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 25 Jul 2023 16:56:47 +0100 Subject: [PATCH] force maven or gradle flag --- .../docs/writing-own-tests/setting-up-galasa-project.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md b/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md index 036d15b0..31defae2 100644 --- a/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md +++ b/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md @@ -10,7 +10,7 @@ You can pass parameters to the `galasactl project create` command, enabling you Maven and Gradle are both build tools, which read metadata from files which guide how the code within a module should be built. Maven and Gradle use different formats for these build files. Artifacts are created on disk and can later be built, tested and deployed to a Maven repository and used in the Galasa Ecosystem. Generated artifacts can be embellished and refactored to form the basis of future Galasa tests. -The `galasactl project create` command uses the `--maven` and `--gradle` parameters to allow you to decide which type of build system to use when creating the example project. By default, the `galasactl project create` command generates a project which includes a Maven build mechanism. You can also pass the `--maven` flag explicitly to tell the tool to generate Maven build artifacts (pom.xml files). +The `galasactl project create` command uses the `--maven` and `--gradle` parameters to allow you to decide which type of build system to use when you create a project. You must specify either the `--maven` flag or the `--gradle` flag when you run the `galasactl project create` command. You can specify both flags to tell the tool to generate Maven build artifacts (pom.xml files) and Gradle files. The example provided in this topic creates a project containing both Maven and Gradle build infrastructure files by specifying the `--maven` and `--gradle` parameters in the command. @@ -102,6 +102,8 @@ where
- ```--force``` is an optional flag. If the flag is missing, then any file that the Galasa CLI tool tries to create which already exists causes a failure, and the original file is preserved. If this flag is used, then such files are silently over-written. Use this option carefully to avoid some of your files being over-written, resulting in the loss of some of your data. - ```--obr``` Creates an OBR project. For tests to run in the ecosystem they require compiled artifacts to be hosted in a Maven repository. The artifacts must be bundled as an OSGI bundle. Creating an OBR project makes it easier to move from running a test locally to running that test in an ecosystem. - ```--log -``` sends the trace and logging output that is generated by the tool to the console. +- ```--maven``` creates a project with a Maven project structure. +- ```--gradle``` creates a project with a Gradle project structure. ## Building the example project @@ -126,7 +128,7 @@ The built artifacts are typically placed in the `~/.m2/repository` in your home ## Understanding the generated artifacts -Running the example Galasa CLI `project create` command creates a number of files in the following standard folder structure: +Running the example Galasa CLI `project create` command with the `--maven` flag specified creates a number of files in the following standard folder structure: ``` .