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

Enrich gradle plugin readme #243

Merged
merged 3 commits into from
Jan 31, 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
33 changes: 29 additions & 4 deletions gradle_plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,36 @@ This is the Gradle plugin of Hydra Lab.
In order to simplify the onboarding procedure to Hydra Lab for any app, this project packaged the client util and made it an easy way for any app to leverage the cloud testing service of Hydra Lab.

## Prerequisite
### TODO
Include Hydra Lab plugin dependency in build.gradle of your project:
- Using the plugins DSL:
```
plugins {
id "com.microsoft.hydralab.client-util" version "${plugin_version}"
}
```
- Using legacy plugin application:
```
buildscript {
repositories {
maven {
url "https://plugins.gradle.org/m2/"
}
}
dependencies {
classpath "com.microsoft.hydralab:gradle_plugin:${plugin_version}"
}
}

apply plugin: "com.microsoft.hydralab.client-util"
```
See [Release Notes](https://github.com/microsoft/HydraLab/wiki/Release-Notes) for latest and stable versions.

## Usage
To trigger gradle task for Hydra Lab testing, simply follow below steps:
- Step 1: go to [template](link to template) page, copy the following files to your repo and modify the content:
- [build.gradle](link to template/build.gradle)
- Step 1: go to [template](https://github.com/microsoft/HydraLab/tree/main/gradle_plugin/src/main/resources/template) page, copy the following files to your repo and modify the content:
- [build.gradle](https://github.com/microsoft/HydraLab/blob/main/gradle_plugin/src/main/resources/template/build.gradle)
- To introduce dependency on this plugin, please copy all content to repository/module you would like to use the plugin in.
- [gradle.properties](link to template/gradle.properties)
- [gradle.properties](https://github.com/microsoft/HydraLab/blob/main/gradle_plugin/src/main/resources/template/gradle.properties)
- According to the comment inline and the running type you choose for your test, you should keep all required parameters and fill in them with correct values.
- Step 2: Build your project/module to enable the Gradle plugin and task
- Step 3: Run gradle task requestHydraLabTest
Expand All @@ -20,3 +42,6 @@ To trigger gradle task for Hydra Lab testing, simply follow below steps:

## Known issue
- Hard-coded with Azure DevOps embedded variable names, currently may not be compatible to other CI tools when fetching commit related information.

## TODO
**- Add yml configuration file for task param setup.**