clamsproject / mmif-visualizer

A web site to visualize MultiMedia Interchange Format json
Apache License 2.0
2 stars 1 forks source link

release model #25

Open keighrim opened 1 year ago

keighrim commented 1 year ago

Right now, there's no fixed release model for the MMIF-viz, but for some reason, we are keeping develop branch. If the develop branch is supposed be a place for snapshot versions, we should have a better release model with a concrete versioning scheme based on PRs from develop to main. Otherwise, namely if you don't use a particular release model and just continuously update the app, the probably we don't need develop branch at all, and instead we can have a daily "deployment" to ghcr as a docker image.

A few things to consider.

  1. mmif-viz has a dependency on the format of MMIF, and thus each "release" of mmif-viz should be bound to a specific version of mmif.
  2. mmif-viz is not a clams app, and we don't have any "consumer" specification in the clams-python package (yet), so at the moment, technically, mmif-viz should not depend on clams-python, but only on mmif-python
  3. dockerization with the static/data symlink hardcoded to /data will cause lots of problems when running with other apps, so we need to figure out either
    1. a way to serve static files outside of static directory, OR
    2. dynamically (or from a pre-configured value) generate symlinks under static/ dorectory.
keighrim commented 1 year ago

With merge of https://github.com/clamsproject/mmif-visualizer/pull/27, I deleted develop branch that was (I think) never relevant, but only added lots of burden of merge conflicts.