ticket2test/README.md

Pull JIRA ticket information and create a JS test file

# Ticket2Test

## Description

I feel like I spend a lot of time copy + pasting JIRA ticket numbers and descriptions into e2e test scripts. I created this in hopes that I never have to do that again.

## Getting Started

> PREREQUISITE: You must have an environmental variable for HOME set (e.g. HOME=/Users/myusername). This is where your `.t2t` file will be created after running `ticket2test config`.

1. `npm install -g ticket2test`
2. `cd path/to/repo`
3. `ticket2test config --server <servername> --username <username> --password <password>`
4. `ticket2test createById --id JIRA-1234`

## Required config

`--server <baseurl>`

The full url for the ticket repo. Currently this project only supports JIRA so it will look something like this by default: `--server https://mycustomjira.atlassian.net`

`--username <username>`

Username for provided server

`--password <password>`

Password for provided server

## Optional config

### template

`--template path/to/template`

This file should export a string literal that includes fields for your ticket repo. See the default template [here](./templates/default.template.js) for an example.

`--outputDir path/to/test/files`

This is the path where you want the test file created. Default is `./tests`

## Roadmap

- Unit tests
- More ticket repo support
- Multiple template/id support
- OAuth
- Additional configurations