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

Update README to reflect why this repo is archived #26

Open
wants to merge 1 commit into
base: nixos-unstable
from

Conversation

@changlinli
Copy link
Contributor

@changlinli changlinli commented Nov 13, 2020

Was a bit confused when I saw that this repository was archived and didn't know what the alternative was. This adds some more background information to clarify what's going on and redirect readers back to the main nixpkgs repo.

(I've deleted the usual GitHub issue template about various steps I've taken to validate packages since this does not affect any packages.)

Was a bit confused when I saw that this repository was archived and didn't know what the alternative was. This adds some more background information to clarify what's going on and redirect readers back to the main nixpkgs repo.
@samueldr
Copy link
Member

@samueldr samueldr commented Nov 13, 2020

Hi, 👋

Thanks for taking time to improve NixOS :)

Few people have write access to this repository, and PRs really shouldn't exist here, but I think you know already. I think the principle behind your changes are good.

Let's see if we can get something useful going here.


@edolstra we might want to make a branch, e.g. 000-readme with a single commit with a README note explaining the archival status of this repository.

This way we don't add a commit that does not exist in Nixpkgs to the main branch.

@edolstra
Copy link
Member

@edolstra edolstra commented Nov 13, 2020

This repo isn't archived yet since we're still mirroring the 20.03 branches to it. See NixOS/nixpkgs#99257. In a few months we can archive it.

@changlinli
Copy link
Contributor Author

@changlinli changlinli commented Nov 13, 2020

Yeah that makes sense, it's just nice to have a note describing why it says deprecated in the description and what to move to instead since this isn't receiving updates anymore.

@edolstra
Copy link
Member

@edolstra edolstra commented Nov 13, 2020

Well, the "About" on the repo page does say "DEPRECATED! This is an obsolete, read-only mirror of the NixOS/nixpkgs repository."

@changlinli
Copy link
Contributor Author

@changlinli changlinli commented Nov 13, 2020

Right but it doesn't say what to do about it or what your alternatives are. I think @samueldr's suggestion is great.

@abathur
Copy link
Member

@abathur abathur commented Nov 14, 2020

@edolstra we might want to make a branch, e.g. 000-readme with a single commit with a README note explaining the archival status of this repository.

This way we don't add a commit that does not exist in Nixpkgs to the main branch.

Just fielded a question in #nixos from someone confused about this. Would making this theoretical README branch the default branch break anything? (I guess maybe if people are relying on getting a useful nixpkgs from git clone https://github.com/NixOS/nixpkgs-channels?)

@unode
Copy link
Member

@unode unode commented Nov 14, 2020

That was me with @abathur on IRC.

Also found the notice and like @changlinli mentioned, I wasn't sure what to do or where to go next.

As there are several issues and places where discussion happened, including the present issue, perhaps a compromise solution would be to add a link to one of the issues, from the "DEPRECATED!" notice/description.

@samueldr
Copy link
Member

@samueldr samueldr commented Nov 14, 2020

Would making this theoretical README branch the default branch break anything? (I guess maybe if people are relying on getting a useful nixpkgs from git clone https://github.com/NixOS/nixpkgs-channels?)

Add a default.nix that throw "useful explanation" in addition to the README.

In fact, I propose all branches, at least the unstable ones, should get a final breaking change, probably a soft trace for a month, and a fatal throw afterward.

I suspect many end-users might accidentally be tracking the unstable branch, and not getting any updates.

@samueldr
Copy link
Member

@samueldr samueldr commented Nov 14, 2020

I also suspect approximately no one reads the "About" blurb, especially for a repo they already know about.

I'm willing to bet that if we changed the, admittedly higher traffic, Nixpkgs repo "About" blurb to I'm a banana! 🍌 hardly anyone would notice.

By this, I mean that the short repository description is probably not enough communication in the constraints github gives us.

@samueldr
Copy link
Member

@samueldr samueldr commented Nov 16, 2020

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

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.