Skip to content

Fix empty neuron.__version__ when git describe fails in shallow clones #3840

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.

Sign up for GitHub

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

Merged
nrnhines merged 2 commits into from
Aug 10, 2026
Merged

Fix empty neuron.__version__ when git describe fails in shallow clones #3840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6d9f0c
Fix empty neuron.__version__ when git describe fails in shallow clones
nrnhines Aug 10, 2026
d668f5d
cmake-format: reflow MacroHelper comment for formatting CI
nrnhines Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions cmake/MacroHelper.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,11 +256,21 @@ endfunction()
function(add_cpp_git_information target scope)
find_program(GIT git)
if(EXISTS "${PROJECT_SOURCE_DIR}/.git" AND GIT)
# Shallow clones: tags may not be ancestors of HEAD, so describe fails and GIT_DESCRIBE would
# stay empty (neuron.__version__ / nrnversion(5)). Fall back to PROJECT_VERSION so release
# dry-run and ship wheels match.
execute_process(
COMMAND "${GIT}" -C "${PROJECT_SOURCE_DIR}" describe
OUTPUT_VARIABLE GIT_DESCRIBE
RESULT_VARIABLE GIT_DESCRIBE_RESULT
OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET)

if(GIT_DESCRIBE_RESULT OR "${GIT_DESCRIBE}" STREQUAL "")
set(GIT_DESCRIBE "${PROJECT_VERSION}")
message(
STATUS "git describe failed or empty; falling back to PROJECT_VERSION=${PROJECT_VERSION}")
endif()

execute_process(
COMMAND "${GIT}" -C "${PROJECT_SOURCE_DIR}" rev-parse --abbrev-ref HEAD
OUTPUT_VARIABLE GIT_BRANCH
Expand Down
2 changes: 2 additions & 0 deletions packaging/python/test_wheels.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,8 @@ $python_exe -m uv pip install -r packaging/python/test_requirements.txt
$python_exe -m uv pip install --force-reinstall $python_wheel
$python_exe -m uv pip show neuron || $python_exe -m uv pip show neuron-nightly

# neuron.__version__ is nrnversion(5)/GIT_DESCRIBE; empty breaks ModelDB workdir naming
$python_exe -c "import neuron; v = neuron.__version__; assert v and str(v).strip(), repr(v)"

# check the existence of coreneuron support
compile_options="$(nrniv -nobanner -nogui -c 'nrnversion(6)')"
Expand Down
Loading