-
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Open
Description
Summary
The docs suggest that pre-commit should be run on every commit to ensure consistency of the codebase. However, I'm encountering an issue where pre-commit is not available inside the devcontainer.
Steps to reproduce
- Clone the repository.
- Open the project in the
devcontainerenvironment using VS Code. - Attempt to run
pre-commit install.
Expected Behavior
pre-commit should be available.
Actual Behavior
Running pre-commit install gives an error mesasge:
root@c97ed173883e:/workspaces/zmk# pre-commit install
bash: pre-commit: command not found
root@c97ed173883e:/workspaces/zmk# pip3 list | grep pre-commit
root@c97ed173883e:/workspaces/zmk#Manually attempting to install pre-commit fails:
root@c97ed173883e:/workspaces/zmk# pip3 install pre-commit
error: externally-managed-environment
× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
python3-xyz, where xyz is the package you are trying to
install.
If you wish to install a non-Debian-packaged Python package,
create a virtual environment using python3 -m venv path/to/venv.
Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
sure you have python3-full installed.
If you wish to install a non-Debian packaged Python application,
it may be easiest to use pipx install xyz, which will manage a
virtual environment for you. Make sure you have pipx installed.
See /usr/share/doc/python3.12/README.venv for more information.
note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.Possible Solution
- Add
pre-committo therequirements.txtfile that is referenced as part of the Dockerfile setup. - (Optional, But Recommended) As part of starting the
devcontainer, runpre-commit installautomatically to ensurepre-commithooks are in place.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels