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

Introduce package "notices" #320

Merged
merged 2 commits into from
Jan 19, 2025

Conversation

mattpolzin
Copy link
Contributor

@mattpolzin mattpolzin commented Jan 18, 2025

I'm putting this implementation up for discussion. I don't know if the feature is desirable or if the name "notice" is the best choice.

The idea is that a package that was previously submitted to the pack collection might become defunct or have other important caveats worth telling users of the package about. For example, I want to move the FVect type from my fvect package into the containers package. I'm not deleting the FVect repository and there's no immediate need to remove it from the pack database -- removing it would potentially break downstream projects without warning. Instead, I would like to archive the GitHub repository and add a "notice" to the pack database entry that instructs consumers to find FVect in the containers package instead.

I especially don't know the most effective place in pack's various processes to surface this notice to the end-user of pack so I just picked a spot that gets hit when installing a package.

@stefan-hoeck
Copy link
Owner

This is a great idea! I have a couple such packages myself, but it never occured to me this could be a warning in pack itself.

@stefan-hoeck stefan-hoeck merged commit 12f5a13 into stefan-hoeck:main Jan 19, 2025
7 checks passed
@mattpolzin mattpolzin deleted the introduce-notice-config branch January 19, 2025 04:47
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.

2 participants