[STORY] Add unittest to cover doc generation

ArcanaFramework / arcana

Abstraction of Repository Centric ANAlysis

Other

4 stars 5 forks source link

[STORY] Add unittest to cover doc generation #91

Closed tclose closed 2 years ago

tclose commented 2 years ago

Description

As a developer, I want to be able to make changes to the Arcana code base without breaking the auto-generation of the pipeline docs used in the pipelines repo

Acceptance Criteria

[x] unittest that covers arcana.cli.deploy.build_docs

Prepultrue commented 2 years ago

In a similar vein, it would be good to add some warnings when a workflow config contains unexpected keys.

tclose commented 2 years ago

currently, the signature of the build_xnat_cs_image function that provides error checking for the build process but I could inspect the signature and include it in the load_yaml_spec

tclose commented 2 years ago

Australian-Imaging-Service/pipelines#33

Prepultrue commented 2 years ago

https://github.com/Australian-Imaging-Service/arcana/pull/107