search

napari / docs

Documentation for napari (other than API docs)
BSD 3-Clause "New" or "Revised" License
11 stars 36 forks source link

Submodule `npe2` instead of cloning in CI #295

Open lucyleeow opened 10 months ago

lucyleeow commented 10 months ago

Should/could we submodule npe2 instead of explicitly cloning it in prep_docs.py

Discussed: https://github.com/napari/docs/issues/291#issuecomment-1841563369

lucyleeow commented 10 months ago

cc @melissawm

Czaki commented 10 months ago

Should/could we submodule npe2 instead of explicitly cloning it in prep_docs.py

So. Submodule is pinning given reference of submodule repository. So it means additional maintenance steep to synchronize with releases of npe2. Current code first clone, then checkout revision that fits to latest released npe2 version.

melissawm commented 10 months ago

If we are just cloning ~latest~ a specific tag, can't we continue doing that with a submodule?

Currently, this is what we do: https://github.com/napari/docs/blob/0c7029e5c9674e9d56c5efbec1022fa302661280/docs/_scripts/prep_docs.py#L26C1-L26C74

melissawm commented 1 week ago

I'll do some research on whether we would get any clear benefits from using a submodule (discussed in the docs WG meeting)