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

docs(archive): clarify deprecation notices #6034

Merged
merged 2 commits into from
Sep 24, 2024
Merged

docs(archive): clarify deprecation notices #6034

merged 2 commits into from
Sep 24, 2024

Conversation

iuioiua
Copy link
Contributor

@iuioiua iuioiua commented Sep 23, 2024

No description provided.

@iuioiua iuioiua requested a review from kt3k as a code owner September 23, 2024 09:58
@iuioiua iuioiua enabled auto-merge (squash) September 23, 2024 09:58
@@ -7,7 +7,7 @@ import type { Reader } from "@std/io/types";
* Base interface for {@linkcode TarMeta}.
*
* @deprecated Use {@linkcode https://jsr.io/@std/tar | @std/tar} instead.
* `@std/archive` will be removed after 0.225.4.
* `@std/archive` will be removed, with 0.225.4 being the last published version.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there's no guarantee that 0.225.4 will be the last version. (For example, it might be required by some CLI updates etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we upgrade archive in the next release, I believe it'll be 0.225.4. After that, the package will be deleted from the codebase and no longer published to JSR. I think that deprecation notice reflects that correctly. Do you have another suggestion?

To clarify, are you saying that if a bug is found with archive, we might re-create the package and publish the bug fix? If so, I think that's too cumbersome a process and we should just urge users to use tar and iterate on that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think @std/tar is not ready yet to replace @std/archive. There seem some limitation that @std/tar has, but @std/archive doesn't have. ref: #6019

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm... Fair point. I'll change this to just say "in the future". We can re-visit later.

@iuioiua iuioiua requested a review from kt3k September 24, 2024 06:17
Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@iuioiua iuioiua merged commit 4e4f3f1 into main Sep 24, 2024
14 checks passed
@iuioiua iuioiua deleted the archive-docs-dep branch September 24, 2024 06:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants