docsteady¶
docsteady is a python package (and optionally Docker container) that talks to Jira and the Adaptavist Test Management system to output Test folders and Test plans to a variety of documents by utilizing pandoc.
docsteady¶
Docsteady generates documents from Jira with the Adaptavist Test Management plugin.
docsteady [OPTIONS] COMMAND [ARGS]...
Options
-
--namespace
<namespace>
¶ Project namespace (dm, ts, example, etc..). Defaults to “dm”.
-
--template-format
<template_format>
¶ Template language (latex, html). Defaults to “latex”.
-
--load-from
<load_from>
¶ Path to search for templates in. Defaults to the working directory
generate-cycle¶
Read in a test cycle and results from Adaptavist Test management where CYCLE is the ATM Test Cycle. If specified, PATH is the resulting output.
If PATH is specified, docsteady will examine the output filename and attempt to write an appendix to a similar file. For example, if the output is jira_docugen.tex, the output will also print out a jira_docugen.appendix.tex file if a template for the appendix is found. Otherwise, it will print to standard out.
docsteady generate-cycle [OPTIONS] CYCLE [PATH]
Options
-
--format
<format>
¶ Pandoc output format (see pandoc for options)
-
--username
<username>
¶ Jira username
-
--password
<password>
¶ Jira Password
Arguments
-
CYCLE
¶
Required argument
-
PATH
¶
Optional argument
Environment variables
-
JIRA_USER
¶ Provide a default for
--username
-
JIRA_PASSWORD
¶ Provide a default for
--password
generate-spec¶
Read in tests from Adaptavist Test management where FOLDER is the ATM Test Case Folder. If specified, PATH is the resulting output.
If PATH is specified, docsteady will examine the output filename and attempt to write an appendix to a similar file. For example, if the output is jira_docugen.tex, the output will also print out a jira_docugen.appendix.tex file if a template for the appendix is found. Otherwise, it will print to standard out.
docsteady generate-spec [OPTIONS] FOLDER [PATH]
Options
-
--format
<format>
¶ Pandoc output format (see pandoc for options)
-
--username
<username>
¶ Jira username
-
--password
<password>
¶ Jira Password
Arguments
-
FOLDER
¶
Required argument
-
PATH
¶
Optional argument
Environment variables
-
JIRA_USER
¶ Provide a default for
--username
-
JIRA_PASSWORD
¶ Provide a default for
--password