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

feat(nix): Add a nixpkgs overlay #1357

Merged
merged 1 commit into from Oct 29, 2023
Merged

feat(nix): Add a nixpkgs overlay #1357

merged 1 commit into from Oct 29, 2023

Conversation

arcuru
Copy link
Sponsor Contributor

@arcuru arcuru commented Oct 29, 2023

This adds a Nix overlay for the Atuin flake.

This makes it easier for a consumer to directly use the repo instead of the packaged version in nixpkgs, and it is fairly standard for this setup. The simple explanation is it lets you overlay the git version of Atuin on top of the standard list of packages.

@vercel
Copy link

vercel bot commented Oct 29, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
atuin-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 29, 2023 6:21pm

Copy link
Member

@ellie ellie left a comment

Choose a reason for hiding this comment

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

Thank you!

@ellie ellie merged commit 21f3f64 into atuinsh:main Oct 29, 2023
10 checks passed
@arcuru arcuru deleted the flake-overlay branch October 29, 2023 19:20
@DoomHammer
Copy link

And how should one use it?

@arcuru
Copy link
Sponsor Contributor Author

arcuru commented Nov 13, 2023

You apply the overlay to nixpkgs, though you'll need to be using Nix flakes.

Using it depends on exactly how you are using nixpkgs but there are examples here which probably apply: https://nixos.wiki/wiki/Overlays#Using_overlays

The overlay to use is generally going to be atuin.overlays.default.

It doesn't look like you are using flakes (based on your dotfiles), so you probably need to define the overlay yourself. Just using overrideAttrs to override the version should be enough: See https://nixos.wiki/wiki/Overlays#Overriding_a_version for some examples. For the rev you can set the tag that you want, e.g. "v17.0.1", or the git commit hash.

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.

None yet

3 participants