Skip to content

pre-commit is not available inside devcontainer #3246

@prdktntwcklr

Description

@prdktntwcklr

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

  1. Clone the repository.
  2. Open the project in the devcontainer environment using VS Code.
  3. 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

  1. Add pre-commit to the requirements.txt file that is referenced as part of the Dockerfile setup.
  2. (Optional, But Recommended) As part of starting the devcontainer, run pre-commit install automatically to ensure pre-commit hooks are in place.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions