[Bug] Project does not support Docker with Pre-commit

[TimidRobot]

Description

The docker environment is the primary supported development environment. It offers better parity with production and testing than a purely local pipenv and related services. However, the pre-commit hooks (as currently documented in README.md) act against the local repository, not the docker environment.

Expectation

If pre-commit cannot be configured to work with the Docker environment, it should be dropped.

Regardless of wether pre-commit is dropped or its configuration is updated, the GitHub action should be updated to better minimize the delta between what is done in developer's environments and what is done via GitHub Actions.

Configurations

• Docker
  1. Dockerfile
  2. docker-compose.yml
• pre-commit
  • main/.pre-commit-config.yaml
• GitHub Action
  • .github/workflows/pre-commit.yml

Additional context

• Docker
  • Dockerfile reference | Docker Documentation
  • Compose file version 3 reference | Docker Documentation
• pre-commit: A framework for managing and maintaining
  multi-language pre-commit hooks.

[ntachukwu]

I see this has the tag for "Hacktoberfest". I am an aspiring intern from Outreachy. Can I use this issue to better understand the code base so I can eventually make contributions on the "Licenses Machine Readable Information" project.

[TimidRobot]

I see this has the tag for "Hacktoberfest". I am an aspiring intern from Outreachy. Can I use this issue to better understand the code base so I can eventually make contributions on the "Licenses Machine Readable Information" project.

@Th3nn3ss Yep! the "Hacktoberfest" tag is not meant to limit involvement.

[Alig1493]

@TimidRobot I'm not sure I understand the issue I was able to use pre commit fine within the docker container. What behaviour are you aiming for exactly? I was also able to create a small service using the app service as a template and tried something like:
docker-compose run pre-commit git commit -a -m "some changes"
And it invoked pre-commit fine as well.

Screenshot

[TimidRobot]

@Alig1493 Yes, you can manually invoke it on the docker container, but the primary purpose of pre-commit is to run prior to each commit (as a git hook). Also, you can run it on the existing app service (ex. docker compose exec app pre-commit run --show-diff-on-failure --color=always --all-files).

While it may be easy enough to add a docker command as a git pre-commit hook, I expect a decent developer experience will require a helper script so that appropriate error messages are issued if a commit is tried and the docker services are unavailable. Ideally, it would be nice to find someone who has written about their experience using docker with git hooks. I'm not convinced a good developer experience is possible.

[Tapo41]

I want to contribute to this if it is still open

[vanamaabhi2004]

assign me

[TimidRobot]

Please see Contribution Guidelines — Creative Commons Open Source for how we manage issues and PRs (we generally don't assign issues prior to resolution).