Environment variable `BVHOOK_NEW_TAG` not working in pre-commit

[stianpram]

Trying to use the environment variable BVHOOK_NEW_TAG as described in Hooks, when setting:

pre_commit_hooks = ["echo \"$BVHOOK_NEW_TAG\" > CHANGELOG.md"]

under [tool.bumpversion] in the TOML, the result is just a blank file.

Using BVHOOK_NEW_VERSION, however:

pre_commit_hooks = ["echo \"$BVHOOK_NEW_VERSION\" > CHANGELOG.md"]

works.

[Viginum-DataScientist-6]

I was facing the same error and diagnosed it to be due to the exported environment variable actually being named BVHOOK_NEW_VERSION_TAG instead of BVHOOK_NEW_TAG.

This can be seen in the bumpversion/hooks.py file here:

bump-my-version/bumpversion/hooks.py

Line 66 in a1e8e6d

return {f"{PREFIX}NEW_VERSION": new_version_string, f"{PREFIX}NEW_VERSION_TAG": new_version_tag}

Mitigation

Either the code should be updated to reflect the docs (but this would break existing behavior) or the docs should be adapted to reflect the actual behavior.

If updating the code, it should be changed to read:

    return {f"{PREFIX}NEW_VERSION": new_version_string, f"{PREFIX}NEW_TAG": new_version_tag}