Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

force maven or gradle flag to be passed when creating a project #686

Merged
merged 2 commits into from
Aug 16, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -103,6 +103,8 @@ where <br>
- ```--obr``` Creates an OBR project. An OBR (OSGi Bundle Repository) is an index of OSGi bundles. Galasa testcases are built into OSGi bundles which are then connected into an OBR. When you specify the location of the OBR to Galasa, the OBR tells Galasa where the tests are stored. You can create an OBR from scratch, or you can create projects and add them into an existing OBR. For more information about OBRs, see the <a href="https://felix.apache.org/documentation/subprojects/apache-felix-osgi-bundle-repository.html" target="_blank"> Apache Felix</a> website.

- ```--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

Expand All @@ -127,7 +129,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:

```
.
Expand Down
Loading