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

python3Packages.mkdocs-git-committers-plugin-2: init at 2.4.1 #344615

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

mahtaran
Copy link

(Same as #343787, renamed branch in my repo. Apologies for spam.)

Description of changes

ojacques/mkdocs-git-committers-plugin-2, primarily used as an optional dependency of Material for MkDocs.

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/)
  • 24.11 Release Notes (or backporting 23.11 and 24.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.

@mahtaran mahtaran changed the title maintainers: add mahtaran python3Packages.mkdocs-git-committers-plugin-2: init at 2.3.0 Sep 26, 2024
@mahtaran mahtaran changed the title python3Packages.mkdocs-git-committers-plugin-2: init at 2.3.0 python3Packages.mkdocs-git-committers-plugin-2: init at 2.4.1 Oct 6, 2024
];

pythonImportsCheck = [ "mkdocs_git_committers_plugin_2" ];

Copy link
Member

Choose a reason for hiding this comment

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

Could you enable tests?

Make sure the tests are enabled using for example pytestCheckHook and, in the case of libraries, are passing for all interpreters. If certain tests fail they can be disabled individually. Try to avoid disabling the tests altogether. In any case, when you disable tests, leave a comment explaining why.

https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/python.section.md#contributing-guidelines-contributing-guidelines

Copy link
Author

Choose a reason for hiding this comment

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

Hmmm, the upstream package does not have any test suite, and since it is a plugin that has to do with Git history, mocking one would be pretty complicated I feel. I explicitly disabled the check for now, but if there's any better way to do it, please let me know!

@nix-owners nix-owners bot requested a review from natsukium October 8, 2024 23:44
@mahtaran
Copy link
Author

mahtaran commented Oct 8, 2024

@natsukium thanks for the review! (and apologies for the rookie mistakes.) I believe I have addressed most (if not all) of your concerns, would you mind having another look?

Signed-off-by: Luka Leer <luka.leer@gmail.com>
Signed-off-by: Luka Leer <luka.leer@gmail.com>
Signed-off-by: Luka Leer <luka.leer@gmail.com>
Signed-off-by: Luka Leer <luka.leer@gmail.com>
@mahtaran mahtaran force-pushed the package/python3Packages/mkdocs-git-committers-plugin-2 branch from 0324ec9 to fa99aa3 Compare October 20, 2024 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants