Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Submodule npe2 instead of cloning in CI #295

Open
lucyleeow opened this issue Dec 6, 2023 · 4 comments
Open

Submodule npe2 instead of cloning in CI #295

lucyleeow opened this issue Dec 6, 2023 · 4 comments

Comments

@lucyleeow
Copy link
Collaborator

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

Discussed: #291 (comment)

@lucyleeow
Copy link
Collaborator Author

cc @melissawm

@Czaki
Copy link
Contributor

Czaki commented Dec 6, 2023

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
Copy link
Member

melissawm commented Dec 6, 2023

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
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

3 participants