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

keylight-cli: init at 1.0.0 #371935

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

keylight-cli: init at 1.0.0 #371935

wants to merge 1 commit into from

Conversation

versality
Copy link

@versality versality commented Jan 7, 2025

Add Elgato Key Light CLI https://github.com/versality/keylight-cli

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@NixOSInfra NixOSInfra added the 12. first-time contribution This PR is the author's first one; please be gentle! label Jan 7, 2025
@versality versality force-pushed the master branch 3 times, most recently from 48a1fa3 to 3e7b214 Compare January 7, 2025 22:33
@versality versality force-pushed the master branch 2 times, most recently from eb64d15 to e9ecabb Compare January 8, 2025 09:49
@versality
Copy link
Author

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review


x86_64-linux

✅ 1 package built:
  • keylight-cli

meta = with lib; {
description = "CLI tool to control Elgato Key Light devices";
homepage = "https://github.com/versality/keylight-cli";
license = licenses.gpl2;
Copy link
Contributor

Choose a reason for hiding this comment

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

licenses.gpl2 is deprecated, consider using licenses.gpl2Only. Or licenses.gpl2Plus if you meant that, but you'd need to state that in your upstream repo.
See:

gpl2 = {

Copy link
Author

Choose a reason for hiding this comment

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

Thank you. I have changed it to licenses.gpl2Only.

Copy link
Contributor

@LucasFA LucasFA left a comment

Choose a reason for hiding this comment

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

maintainer-list.nix entry looks good, githubID matches username.

src = fetchFromGitHub {
owner = "versality";
repo = "keylight-cli";
rev = "46ff8472f9544e16eea822bf274acf4a5cbedbe8";
Copy link
Contributor

Choose a reason for hiding this comment

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

I just realised that the rev field in fetchFromGithub can be a git tag, like "v${version}", in this case.

Copy link
Author

@versality versality Jan 19, 2025

Choose a reason for hiding this comment

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

I just realised that the rev field in fetchFromGithub can be a git tag, like "v${version}", in this case.

Thanks for the suggestion! The upstream repo doesn't use tags yet, but I'll consider adding them in the future. For now, the git hash should work fine for pinning the version.

Copy link
Contributor

Choose a reason for hiding this comment

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

There's also the passthru.updateScript = nix-update-script { }, see the wiki article on it. I can't vouch for it as I haven't yet used it, only requested to use it on a PR of mine 😅

I don't think this is really a requirement, though.

Copy link
Author

Choose a reason for hiding this comment

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

There's also the passthru.updateScript = nix-update-script { }, see the wiki article on it. I can't vouch for it as I haven't yet used it, only requested to use it on a PR of mine 😅

I don't think this is really a requirement, though.

Thanks for mentioning the updateScript! Since this is the initial package submission, I'd prefer to keep it simple for now. I can look into adding the update script in a future PR once the basic package is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 12. first-time contribution This PR is the author's first one; please be gentle!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants