search

jrnxf / gh-eco

🦎 gh cli extension to explore the ecosystem
MIT License
406 stars 6 forks source link

readme update to reflect nixpkgs packaging #2

Closed helium18 closed 2 months ago

helium18 commented 2 years ago

What: Packaged gh-eco for Nixpkgs :)

Why: Installing extensions from gh doesn't work on NixOS (Read only file system). Therefore I decided to package it.

How: updated the README (actual PR: https://github.com/NixOS/nixpkgs/pull/175699/files)

Checklist:

jrnxf commented 2 years ago

Hey thanks for doing this! Will this need to be updated every release?

helium18 commented 2 years ago

yes!

jrnxf commented 2 years ago

@helium18 do you have any documentation on how I can do that? Given you already created it I'm not sure if that means you'd be the one to constantly update it? I don't want to have to do that to you 😅

helium18 commented 2 years ago

here's the documentation for the go module https://ryantm.github.io/nixpkgs/languages-frameworks/go/

the default.nix file is located in pkgs/tools/misc/gh-eco You just need to update the version field and empty the sha256 and vendorSha256 fields

Then go to the repo root and run nix build -A gh-eco. This should fail with an error on the lines of specified Sha=<some_random_sha> got <some_sha>. So now you can fill the missing fields (which are sha256 and vendorSha256) in default.nix and finally run nix build -A gh-eco again and it should work now

Test the package by running ./result/bin/gh-eco in the repo root. If everything runs fine, you can now submit a PR

https://nixos.wiki/wiki/Nixpkgs/Create_and_debug_packages

I'll update the package since its a simple go module, so you don't need to worry :+1:

jrnxf commented 2 months ago

Picked this back up today to fix a few bugs, and I'm not sure I love the dependency on you here (nothing against you at all) If I push a fix up and the nix package never gets updated, that wouldn't be great imo. Would rather maintain one myself, but also don't know how much a need there is for it to be a nixpkgs. If the ask comes up again I'll reconsider!