nixpkgs/pkgs/development/python-modules/commitizen/default.nix

136 lines
3.0 KiB
Nix

{
lib,
commitizen,
fetchFromGitHub,
buildPythonPackage,
git,
pythonOlder,
stdenv,
installShellFiles,
poetry-core,
nix-update-script,
testers,
argcomplete,
charset-normalizer,
colorama,
decli,
importlib-metadata,
jinja2,
packaging,
pyyaml,
questionary,
termcolor,
tomlkit,
py,
pytest-freezer,
pytest-mock,
pytest-regressions,
pytest7CheckHook,
deprecated,
}:
buildPythonPackage rec {
pname = "commitizen";
version = "3.30.0";
pyproject = true;
disabled = pythonOlder "3.8";
src = fetchFromGitHub {
owner = "commitizen-tools";
repo = "commitizen";
rev = "refs/tags/v${version}";
hash = "sha256-8ULIoFKrDAGHwz0EZzYJtl/4h6UVUECLUDbvTJbdD60=";
};
pythonRelaxDeps = [
"argcomplete"
"decli"
];
build-system = [ poetry-core ];
nativeBuildInputs = [ installShellFiles ];
dependencies = [
argcomplete
charset-normalizer
colorama
decli
importlib-metadata
jinja2
packaging
pyyaml
questionary
termcolor
tomlkit
];
nativeCheckInputs = [
argcomplete
deprecated
git
py
pytest-freezer
pytest-mock
pytest-regressions
pytest7CheckHook
];
pythonImportsCheck = [ "commitizen" ];
# The tests require a functional git installation
# which requires a valid HOME directory.
preCheck = ''
export HOME="$(mktemp -d)"
git config --global user.name "Nix Builder"
git config --global user.email "nix-builder@nixos.org"
git init .
'';
# NB: These tests require complex GnuPG setup
disabledTests = [
"test_bump_minor_increment_signed"
"test_bump_minor_increment_signed_config_file"
"test_bump_on_git_with_hooks_no_verify_enabled"
"test_bump_on_git_with_hooks_no_verify_disabled"
"test_bump_pre_commit_changelog"
"test_bump_pre_commit_changelog_fails_always"
"test_get_commits_with_signature"
# fatal: not a git repository (or any of the parent directories): .git
"test_commitizen_debug_excepthook"
];
postInstall =
let
register-python-argcomplete = lib.getExe' argcomplete "register-python-argcomplete";
in
lib.optionalString (stdenv.buildPlatform.canExecute stdenv.hostPlatform) ''
installShellCompletion --cmd cz \
--bash <(${register-python-argcomplete} --shell bash $out/bin/cz) \
--zsh <(${register-python-argcomplete} --shell zsh $out/bin/cz) \
--fish <(${register-python-argcomplete} --shell fish $out/bin/cz)
'';
passthru = {
updateScript = nix-update-script { };
tests.version = testers.testVersion {
package = commitizen;
command = "cz version";
};
};
meta = with lib; {
description = "Tool to create committing rules for projects, auto bump versions, and generate changelogs";
homepage = "https://github.com/commitizen-tools/commitizen";
changelog = "https://github.com/commitizen-tools/commitizen/blob/v${version}/CHANGELOG.md";
license = licenses.mit;
mainProgram = "cz";
maintainers = with maintainers; [
lovesegfault
anthonyroussel
];
};
}