Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
martingrossmann committed Mar 15, 2021
1 parent 2284e81 commit 13c6c4c
Showing 1 changed file with 20 additions and 28 deletions.
48 changes: 20 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
<p align="center">
<a href="#installation">Installation</a> •
<a href="#documentation">Documentation</a> •
<a href="#development">Development</a> •
<a href="#support-and-feedback">Support</a> •
<a href="#how-to-contribute">Contribute</a> •
<a href="#contributors">Contributors</a> •
Expand All @@ -18,17 +17,19 @@

## About this module

This module for Testerra provides a simple synchronization service for Microsoft AzureDevOps platform.
This module provides additional features for [Testerra Framework](https://github.com/telekom/testerra) for automated tests.

This module provides a simple synchronization service for Microsoft AzureDevOps platform.

It will register automatically by using Testerra `ModuleHook`, but you have to provide a valid property file its usage.

---
## Setup

## Requirements
### Requirements

This module requires Testerra version `1.0-RC-30`.
* Testerra in Version: `1.0-RC-30`

## Usage
### Usage

Include the following dependency in your project.

Expand All @@ -46,15 +47,7 @@ Maven:
</dependency>
````

### Test method mapping

````java
@Test
@AzureTest(id = 2257)
public void test_case_01() {
...
}
````
## Documentation

### Properties

Expand All @@ -72,6 +65,18 @@ Add the property file ``azuredevops.properties`` and add project specific settin
| azure.testplan.id | na. | Define the test plan where your test cases are added. |
| azure.run.name | Current timestamp | Define a custom name for the test run. |

### Test method mapping

Map your tests with the corresponding AzureDevops ticket id.

````java
@Test
@AzureTest(id = 2257)
public void test_case_01() {
...
}
````

---

## Publication
Expand Down Expand Up @@ -99,10 +104,6 @@ Some hints for using GitHub Packages as Maven repository
* Deploy URL is https://maven.pkg.github.com/OWNER/REPOSITRY
* As password generate an access token and grant permissions to ``write:packages`` (Settings -> Developer settings -> Personal access token)

## Documentation

Check out our comprehensive [Testerra documentation](http://docs.testerra.io)!

## Code of Conduct

This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) in version 2.0 as our code of conduct. Please see the details in our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). All contributors must abide by the code of conduct.
Expand All @@ -123,15 +124,6 @@ The following channels are available for discussions, feedback, and support requ
| **Issues** | <a href="/../../issues/new/choose" title="Issues"><img src="https://img.shields.io/github/issues/telekom/testerra-azure-devops-connector?style=flat"></a> |
| **Other Requests** | <a href="mailto:[email protected]" title="Email us"><img src="https://img.shields.io/badge/email-CWA%20team-green?logo=mail.ru&style=flat-square&logoColor=white"></a> |


## Repositories

| Repository | Description |
| ------------------- | --------------------------------------------------------------------- |
| [testerra] | Testerra |

[testerra]: https://github.com/telekom/testerra

## How to Contribute

Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](./CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times.
Expand Down

0 comments on commit 13c6c4c

Please sign in to comment.