Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
martingrossmann committed Jul 21, 2022
1 parent a1e195a commit 395f653
Showing 1 changed file with 17 additions and 18 deletions.
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,25 +29,28 @@ It will register automatically by using Testerra `ModuleHook`, but you have to p
### Requirements


| Azure devops connector | Testerra |
| -------------------- | --------------|
| `>= 1.0` | `>= 1.9` |
| Azure devops connector | Testerra |
|------------------------|----------|
| `>= 1.0` | `>= 1.9` |
| `>= 2.0` | `>=2.0` |

Tested with API version 5.0 at Azure DevOps Server 2020 Update 1.1 (5.1 and 6.0 are not working, cannot add result to run)

### Usage

Include the following dependency in your project.

Gradle:
````groovy
implementation 'io.testerra:azure-devops-connector:1.2'
implementation 'io.testerra:azure-devops-connector:2.0'
````

Maven:
````xml
<dependency>
<groupId>io.testerra</groupId>
<artifactId>azure-devops-connector</artifactId>
<version>1.2</version>
<version>2.0</version>
</dependency>
````

Expand Down Expand Up @@ -95,10 +98,6 @@ Steps for sync
| 4 | Create a test result and add it to the run. | Request contains the test point. https://docs.microsoft.com/en-us/rest/api/azure/devops/test/results/add?view=azure-devops-rest-6.0 |
| 5 | Update the run | Set finisher date and close the run. https://docs.microsoft.com/en-us/rest/api/azure/devops/test/runs/update?view=azure-devops-rest-6.0 |

### Compatibility

- Tested with API version 5.0 at Azure DevOps Server 2020 Update 1.1 (5.1 and 6.0 are not working, cannot add result to run)

---

## Publication
Expand All @@ -107,15 +106,15 @@ This module is deployed and published to Maven Central. All JAR files are signed

The following properties have to be set via command line or ``~/.gradle/gradle.properties``

| Property | Description |
| ----------------------------- | --------------------------------------------------- |
| `moduleVersion` | Version of deployed module, default is `1-SNAPSHOT` |
| `deployUrl` | Maven repository URL |
| `deployUsername` | Maven repository username |
| `deployPassword` | Maven repository password |
| `signing.keyId` | GPG private key ID (short form) |
| `signing.password` | GPG private key password |
| `signing.secretKeyRingFile` | Path to GPG private key |
| Property | Description |
|-----------------------------|-----------------------------------------------------|
| `moduleVersion` | Version of deployed module, default is `1-SNAPSHOT` |
| `deployUrl` | Maven repository URL |
| `deployUsername` | Maven repository username |
| `deployPassword` | Maven repository password |
| `signing.keyId` | GPG private key ID (short form) |
| `signing.password` | GPG private key password |
| `signing.secretKeyRingFile` | Path to GPG private key |

If all properties are set, call the following to build, deploy and release this module:
````shell
Expand Down

0 comments on commit 395f653

Please sign in to comment.