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.
Create a conda environment based on the docsteady conda package::
conda create --name docsteady-env docsteady -c lsst-dm -c conda-forge
Credentials are needed by docsteady to log into JIRA. The easiest way to do this is
by setting up the following environment variables::
export JIRA_USER= export JIRA_PASSWORD=
The defaults of docsteady are to build documents based on DM defaults. The following commands are available:
generate-spec: to generate a Test Specification (baselining test cases)generate-report: for test plans and reportsgenerate-vcd: to generate the Verification Control Documentsbaseline-ve: to generate Verification Elements baseline documents.
See the docsteady documentation.
Please refer to the Developer Guide for contribution information.