Repository navigation
This release focuses on two big fronts: Windows stability and documentation.
On the Windows side, drive-letter paths being silently remapped to UNC paths is finally addressed. Repositories that were unresolvable when accessed through mapped drives now work again, and a new opt-in resolve_links_on_windows setting gives control over symlink/junction resolution. Building packages with CMake on Windows now works again, and physical core counts are queried through the native Win32 API instead of a slow PowerShell subprocess, and several environment-handling correctness issues were fixed for combined packages, parent_environ case sensitivity, and CMAKE_MODULE_PATH normalization.
The documentation received another enormous overhaul: a brand new getting-started guide, fully documented plugin settings, a fix for most Sphinx warnings, Sphinx domain support for intersphinx consumers, and many smaller clarifications. A huge thank you to @ankurc for the new guide, and to everyone who contributed fixes, tests, and reviews - including a number of first-time contributors to the project.
Finally, this release clears a backlog of deprecations and internal debt: deprecated importlib.load_module() usage is gone, a shutdown-time circular import under REZ_LOG_DEPRECATION_WARNINGS=1 is fixed, and the project has continued its migration to move linting from flake8 to ruff. zsh users also get a critical fix: shell completion has been rewritten to follow compctl -K conventions. And alongside everything above, this release adds a large amount of new tests and safety guards throughout the codebase - covering the release hook machinery, the Windows path-handling logic, combined-package bindings, bundling, and more.
Features
- Add
baseandrootbindings topre_test_commands#2032 (@Ni-g-3l) - Preserve drive-letter paths on Windows (fixes UNC remapping) with a new
resolve_links_on_windowsoption #2104 (@maxnbk) - Allow synchronous package caching outside production installs #2151 (@manuelkoester)
Fixes
- Fix combined-package
base/rootbinding crash on Windows #1759 (@cfxegbert) - Allow building with CMake on Windows #2090 (@gabrieljreed)
- Fix
parent_environcase sensitivity on Windows #2098 (@thc1006) - Fix base26 identifier ordering and input validation #2156 (@darrenhuai)
- Fix late-bound
requiresattributes returning None #2158 (@maxnbk) - Fix slow Windows physical core count queries by using
ctypesand the native Win32 API #2187 (@nrusch) - Fix zsh completion to use
compctl -Kconventions #2217 (@mmdanggg2) - Replace deprecated
importlib.load_module()in plugin and selftest discovery #2232 (@maxnbk) - Fix circular import when
REZ_LOG_DEPRECATION_WARNINGS=1is enabled #2238 (@maxnbk) - Remove redundant
rez.util._atexitexit callback #2207 (@JeanChristopheMorinPerso)
Documentation
- Fix the documented type of
plugin_for#2128 (@cfxegbert) - Document
REZ_ORIG_ROOTandREZ_PKG_ORIG_ROOT#2181 (@JeanChristopheMorinPerso) - Fix most Sphinx warnings #2182 (@JeanChristopheMorinPerso)
- Add Sphinx domains for intersphinx consumers #2183 (@JeanChristopheMorinPerso)
- Improve Python docstrings for core modules #2184 (@JeanChristopheMorinPerso)
- Improve configuration environment variable docs #2189 (@JeanChristopheMorinPerso)
- Clarify package variant shadowing across repositories #2190 (@JeanChristopheMorinPerso)
- Fix package commands docs #2193 (@JeanChristopheMorinPerso)
- Clarify source archive download in docs #2198 (@JeanChristopheMorinPerso)
- Rewrite the getting started guide #2203 (@ankurc)
- Fix typos in
rezconfig.pyexamples #2213 (@doruchan) - Fully document plugin settings #2215 (@JeanChristopheMorinPerso)
Tests
Internal
- Add semgrep ignores for false positives #2028 (@instinct-vfx)
- Migrate from flake8 to ruff #2126 (@cfxegbert)
- Improve release script #2127 (@JeanChristopheMorinPerso)
- Fix benchmark workflow Python version #2146 (@JeanChristopheMorinPerso)
- Address ASWF LLM scanner project health findings #2154 (@maxnbk)
- Fix invalid
noqawarning #2155 (@JeanChristopheMorinPerso) - Fix ruff ISC004 in
platform_.py#2175 (@maxnbk) - Clean up legacy code #2119 (@cfxegbert)
- Fix ruff version pin and minor format/lint issue #2229 (@maxnbk)