search

biothings / biothings.api

BioThings API framework - Making high-performance API for biological annotation data
https://biothings.io
Apache License 2.0
45 stars 25 forks source link

Adding build doc adapter for release note generation #209

Open erikyao opened 2 years ago

erikyao commented 2 years ago

Related Issue in MyVariant: https://github.com/biothings/myvariant.info/issues/103

Currently hub/datarelease/publisher.py generates release notes directly from build docs, JsonDiff module, and ES clients. Considering the complexity of the structure of the build docs, introducing an adapter of build docs, which extracts the essential information from build docs for release note generation, will lower the cost of maintenance.

erikyao commented 2 years ago

Newly designed adapter modules:

mermaid-diagram-20220405135339

erikyao commented 2 years ago

To be implemented along with https://github.com/biothings/myvariant.info/issues/103