Warning about repo being archived #344

TomNicholas · 2024-10-23T16:44:23Z

No description provided.

TomNicholas · 2024-10-23T17:07:57Z

God damnit I don't want to have to fix sphinx and conda build issues just to archive this repo anyway. @keewis do you think I can just merge and release this regardless of the CI not working?

keewis · 2024-10-23T17:24:43Z

we have to fix sphinx so we can publish the changed docs, and if we want to release we should also check that the package still works. So looks like we can't skip that, unfortunately?

TomNicholas · 2024-10-23T18:57:25Z

ImportError: cannot import name 'HybridMappingProxy' from 'xarray.core.utils'

This is interesting - this change was done by Stephan recently as part of the datatree refactor. I think I will just pin xarray to <=2024.09.0 (the last released version before that change). If that causes a problem for anyone then it's just a sign they should migrate.

keewis · 2024-10-23T19:03:24Z

I think pinning should be fine, nobody should need to have two versions of datatree at the same time.

If it's fine with you I'll try to get the docs to at least compile (by pushing to this branch).

keewis · 2024-10-23T19:16:19Z

looks like the issue was the deprecation / discontinuation of sphinx-panels

Edit: it passed on RTD, not just locally

for more information, see https://pre-commit.ci

keewis · 2024-10-23T19:31:16Z

I think we can ignore the failing dev CI (xarray does not support 3.9 anymore, so the last release that did is pulled in, which makes it the only "dev" CI to succeed), so this should be good to go?

keewis

actually, one comment about the links to the migration guide, but otherwise this looks good to me

keewis · 2024-10-23T19:33:32Z

datatree/__init__.py

+warnings.warn(
+    "The repository `xarray-contrib/datatree` has been archived! It is no longer maintained as of October 2024. "
+    "Datatree functionality has been migrated upstream to `pydata/xarray`, so please use `xarray.DataTree` instead. "
+    "To help you migrate there is a guide at https://github.com/pydata/xarray/blob/main/DATATREE_MIGRATION_GUIDE.md",


this might be tricky to change since we do plan on moving it out of the xarray repository at some point. Should we instead point to a dedicated discussion here that we can more easily modify?

keewis · 2024-10-23T19:34:30Z

docs/source/index.rst

+
+There will be no further bugfixes or feature additions to this respository.
+
+Users of this repository should migrate to using `xarray.DataTree` instead, following the `Migration Guide <https://github.com/pydata/xarray/blob/main/DATATREE_MIGRATION_GUIDE.md>`_.


same here: should we link to a discussion on the datatree repository?

TomNicholas · 2024-10-23T19:56:44Z

should we link to a discussion on the datatree repository?

Perhaps I should raise one single issue on this repo and pin it, as another form of warning. That becomes read-only once archived though. That can have a multitude of links, and we can point to that issue from the warning. How does that sound?

TomNicholas · 2024-10-23T19:57:15Z

looks like the issue was the deprecation / discontinuation of sphinx-panels

also thank you helping with that! Really appreciate it.

keewis · 2024-10-23T20:31:21Z

That becomes read-only once archived though. That can have a multitude of links, and we can point to that issue from the warning. How does that sound?

That's fine, you can temporarily un-archive a repository to change the link – which is much easier than having to re-release again with a changed link.

But otherwise this sounds good to me!

TomNicholas · 2024-10-23T20:34:57Z

Raised #345, so I will merge this PR and release as soon as we release xarray.

keewis · 2024-10-23T20:36:09Z

after updating the links?

TomNicholas · 2024-10-23T20:40:07Z

By updating the links you mean link to the new release of xarray? I can do that.

keewis · 2024-10-23T20:41:18Z

nah, I meant change the link to the migration guide to issue. Also, might be good to ask people to open discussions on the xarray repository if they need help with the migration.

keewis

I was thinking of something like this, but doesn't as helpful as directly linking to the guide. However, just to really stress this, I do think we can save ourselves a lot of trouble by keeping the link to the migration guide mutable.

keewis · 2024-10-23T22:02:15Z

README.md

-PLEASE RAISE NEW ISSUES ON THE XARRAY REPOSITORY UPSTREAM
+There will be no further bugfixes or feature additions to this respository.
+
+Users of this repository should migrate to using `xarray.DataTree` instead, following the [Migration Guide](https://github.com/pydata/xarray/blob/main/DATATREE_MIGRATION_GUIDE.md).


Suggested change

Users of this repository should migrate to using `xarray.DataTree` instead, following the [Migration Guide](https://github.com/pydata/xarray/blob/main/DATATREE_MIGRATION_GUIDE.md).

for more information and a link to the migration guide see [this issue](https://github.com/xarray-contrib/datatree/issues/345)

TomNicholas · 2024-10-24T15:24:25Z

Maybe actually instead I should make a new discussion on pydata/xarray, pin it, and use that both to link to the migration guide and collect feedback / tips for datatree users. That link will be just as permanent as an issue, so the warnings can just link to that. What do you think?

keewis · 2024-10-24T18:11:28Z

that would be better, actually, people are less likely to try to open an issue here if we directly link to the xarray repository.

TomNicholas added 4 commits October 23, 2024 12:22

add DeprecationWarning on import

7bb738f

big wrarning in README

0191f70

add big fat warning to docs landing page too

967662d

try adding prolog to every page

d241cdc

TomNicholas added documentation Improvements or additions to documentation packaging labels Oct 23, 2024

rearrange emojis

8d65f31

TomNicholas added 3 commits October 23, 2024 14:47

try updating micromamba action

64566c0

also update micromamba for other job

9179cf2

fix expected repr diff

019418e

TomNicholas and others added 5 commits October 23, 2024 15:11

pin xarray

1c48ed5

pin to earlier version

0b23e98

upgrade the python version for docs

b53b962

require a more recent version of sphinx

aa59a95

replace sphinx-panels with sphinx-design

47110b4

keewis and others added 4 commits October 23, 2024 21:23

disable the mypy hook

dbeb958

autoupdate hook versions

d9f6d4a

[pre-commit.ci] auto fixes from pre-commit.com hooks

6fa3497

for more information, see https://pre-commit.ci

ignore flake8 errors that conflict with black

669a8bf

keewis reviewed Oct 23, 2024

View reviewed changes

TomNicholas mentioned this pull request Oct 24, 2024

Track merging datatree into xarray pydata/xarray#8572

Closed

27 tasks

TomNicholas added 2 commits October 24, 2024 18:03

update link in warning to release discussion upstream

2ed2105

update links

fe7e0c2

TomNicholas enabled auto-merge (squash) October 24, 2024 22:06

TomNicholas disabled auto-merge October 24, 2024 22:08

keewis approved these changes Oct 24, 2024

View reviewed changes

TomNicholas merged commit 5f3956f into xarray-contrib:main Oct 24, 2024
10 of 13 checks passed

TomNicholas deleted the archive_repo branch October 24, 2024 22:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Warning about repo being archived #344

Warning about repo being archived #344

TomNicholas commented Oct 23, 2024

TomNicholas commented Oct 23, 2024

keewis commented Oct 23, 2024 •

edited

Loading

TomNicholas commented Oct 23, 2024

keewis commented Oct 23, 2024

keewis commented Oct 23, 2024 •

edited

Loading

keewis commented Oct 23, 2024

keewis left a comment

keewis Oct 23, 2024 •

edited

Loading

keewis Oct 23, 2024 •

edited

Loading

TomNicholas commented Oct 23, 2024

TomNicholas commented Oct 23, 2024

keewis commented Oct 23, 2024 •

edited

Loading

TomNicholas commented Oct 23, 2024

keewis commented Oct 23, 2024

TomNicholas commented Oct 23, 2024

keewis commented Oct 23, 2024

keewis left a comment

keewis Oct 23, 2024

TomNicholas commented Oct 24, 2024

keewis commented Oct 24, 2024


		There will be no further bugfixes or feature additions to this respository.

		Users of this repository should migrate to using `xarray.DataTree` instead, following the `Migration Guide <https://github.com/pydata/xarray/blob/main/DATATREE_MIGRATION_GUIDE.md>`_.

	Users of this repository should migrate to using `xarray.DataTree` instead, following the [Migration Guide](https://github.com/pydata/xarray/blob/main/DATATREE_MIGRATION_GUIDE.md).
	for more information and a link to the migration guide see [this issue](https://github.com/xarray-contrib/datatree/issues/345)

Warning about repo being archived #344

Warning about repo being archived #344

Conversation

TomNicholas commented Oct 23, 2024

TomNicholas commented Oct 23, 2024

keewis commented Oct 23, 2024 • edited Loading

TomNicholas commented Oct 23, 2024

keewis commented Oct 23, 2024

keewis commented Oct 23, 2024 • edited Loading

keewis commented Oct 23, 2024

keewis left a comment

Choose a reason for hiding this comment

keewis Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

keewis Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

TomNicholas commented Oct 23, 2024

TomNicholas commented Oct 23, 2024

keewis commented Oct 23, 2024 • edited Loading

TomNicholas commented Oct 23, 2024

keewis commented Oct 23, 2024

TomNicholas commented Oct 23, 2024

keewis commented Oct 23, 2024

keewis left a comment

Choose a reason for hiding this comment

keewis Oct 23, 2024

Choose a reason for hiding this comment

TomNicholas commented Oct 24, 2024

keewis commented Oct 24, 2024

keewis commented Oct 23, 2024 •

edited

Loading

keewis commented Oct 23, 2024 •

edited

Loading

keewis Oct 23, 2024 •

edited

Loading

keewis Oct 23, 2024 •

edited

Loading

keewis commented Oct 23, 2024 •

edited

Loading