AcademySoftwareFoundation / AcademySoftwareFoundation/rez
rez bind behavior change and possible break on Windows
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 369
- Avg merge
- 12d 3h
- Merged PRs (30d)
- 5
Description
Hey Allan,
The addition of the --no-deps option to "rez bind" has substantially changed the default behavior of that command: whereas in prior versions dependencies were not installed, now you're installing them by default.
In and of itself not a problem, however in many Windows domains (including ours) os.symlink will fail on machines by default (the user is NOT granted permissions to make a symlink without running the mklnk command in a shell that has elevated Administrator privileges -- similar to sudo, but with all the usual half-assery of Windows), which leads to "rez bind rez" failing with all sorts of interesting messages when it automatically attempts to bind the system Python as a dependency.
Internally we NEVER want to bind the system Python (it's potentially very different on every machine), so this new default tripped us up, but I don't think it's really a problem, just an opportunity for some better documentation.
M
Contributor guide
Research direction
Start by reading the documentation and command entry point for `rez bind`, including the `--no-deps` option. Document that dependencies are now installed by default, explain the Windows `os.symlink` permission problem, and note how to avoid binding system Python; done when these behavior and workaround details are clear to users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100