generate-atm-test-cycle/README.md

npm module to create a new test cycle in Adaptavist test management tool

## generate-atm-test-cycle:

This is a npm module to generate test cycle in Adaptavist test management tool. Test cycle will be generated with default cycle name of ```Regression | <Local date time>``` if no environment variable set for ```TEST_CYCLE_NAME```. Generated cycle id will output to console and also to a text file named ```cycleID.txt``` for use, if required.

## Install:
npm install generate-atm-test-cycle

## Environment Variables:
Set following environment variables on your machine:
```
BASE_URL = baseurl (e.g. --> jira.abcdef.com)
JIRA_USERNAME = username
JIRA_PASSWORD = password
PROJECT_KEY = XYZ
TEST_PLAN_KEY = SampleTestPlanID (to associate test cycle with a test plan - this is optional)
TEST_CYCLE_NAME = SampleTestCycle
```

## Usage:

Sample usage example from a JEST global setup file:

```
const cycle = require('generate-atm-test-cycle');

module.exports = async function() {
    cycle.createTestCycle();
};
```