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

Replace example data submodule with subtree #2105

Merged
merged 7 commits into from
Sep 8, 2022
Merged

Replace example data submodule with subtree #2105

merged 7 commits into from
Sep 8, 2022

Conversation

sethaxen
Copy link
Member

@sethaxen sethaxen commented Aug 27, 2022

Description

As discussed on Slack, this replaces the git submodule approach with including example data in this repo (#2096) with an approach using git subtree. This makes management slightly more complicated on the developer side but makes it easier whenever one needs to download the repo, as special commands are no longer necessary to clone the repo. See https://stackoverflow.com/questions/31769820/differences-between-git-submodule-and-subtree for some comparisons between the two approaches.

Checklist

  • Follows official PR format
  • New features are properly documented (with an example if appropriate)?
  • Changes are listed in changelog

📚 Documentation preview 📚: https://arviz--2105.org.readthedocs.build/en/2105/

git-subtree-dir: arviz/data/example_data
git-subtree-split: 594a6addd3aeddbd5d03e1a59300a1dcf0491a68
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@sethaxen
Copy link
Member Author

sethaxen commented Aug 27, 2022

We should document somewhere how developers should update the subtree if arviz_example_data is updated:

$ git subtree pull --prefix arviz/data/example_data https://github.com/arviz-devs/arviz_example_data.git main --squash

Where's a good place for that?

@sethaxen
Copy link
Member Author

@ahartikainen thoughts on this question?

@OriolAbril
Copy link
Member

I would say some of the pages in https://python.arviz.org/en/latest/contributing/index.html. Maybe a new one in how-to guides?

@sethaxen
Copy link
Member Author

sethaxen commented Sep 8, 2022

I would say some of the pages in https://python.arviz.org/en/latest/contributing/index.html. Maybe a new one in how-to guides?

Done! https://arviz--2105.org.readthedocs.build/en/2105/contributing/updating_example_data.html

Unless anything on that page needs to change, this should be ready to merge.

@OriolAbril OriolAbril merged commit 31c1a83 into main Sep 8, 2022
@OriolAbril OriolAbril deleted the exdatasubtree branch September 8, 2022 16:03
@OriolAbril OriolAbril added this to the v0.13 milestone Sep 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants