search

linkml / linkml-project-cookiecutter

A cookiecutter for linkml projects. An equivalent of `linkml-ws new project-name`.
Creative Commons Zero v1.0 Universal
14 stars 16 forks source link

Add a migration guide #59

Open cmungall opened 1 year ago

cmungall commented 1 year ago

We should add a guide (or just a few lines to the README) that descibes how to migrate an older linkml repo to cookiecutter

there is no one size fits all approach here. Approaches vary from:

  1. abandon old repo and create a new repo
    • disadvantages:
      • history broken (may not matter with small projects)
      • issues forked (can be migrated one by one using gh interface)
  2. remove all files from current repo. create new repo using cc. copy all files across using cp -pr. git add -a
    • similar to above but issues preserved
  3. create a new repo using cc
    • do not push
    • use new repo as an exemplar
    • manually rm and mv files in the existing repo to match the template
    • this is more work than 1/2 but should preserve history/issues
    • note that if you miss a file or put something in the wrong place it could lead to hard to debug makefile issues