differential-shellcheck pre-commit

[mpoberezhniy]

Issue: redhat-plumbers-in-action/differential-shellcheck#234

TODO:

• Merge required changes to the differential-shellcheck repo (Allow specifying WORK_DIR for intermediate files redhat-plumbers-in-action/differential-shellcheck#393)
• Actions to autoupdate once a week: run autoupdate and push tags, also should take into consideration the fact that the current version is not supported. E.g. start pulling from 5.1.3.
• Actions to create docker images on a release tag push
• Redo the hook output to be less actions oriented
• Tests coverage

[mpoberezhniy]

Testing.
A docker image can be pulled and used as follows.

sudo docker run -t --rm --user="$(id -u):$(id -g)" --workdir=/src -v "$PWD":/src:rw,Z ghcr.io/mpoberezhniy/differential-shellcheck-precommit:v0.0.1

[jamacku]

I'm not a pre-commit user, but I think you are specifying the exact version you are using, so unless you update to a potentially broken version, everything should work.

I'm not against having a separate repo. On the other hand, having it in one repo would make it easier to add a set of tests that could prevent the pre-commit hook from breaking. But there would have to be certainly some level of cooperation either way :-)

[mpoberezhniy]

As of my pre-commit autoupdate code understanding, it pulls a repo copy locally (a precommit repo to be specific), iterates over tags, and selects the newest version to use. I think if this repo has proper actions to build release images - it should be stable.

I am open to merging this repository to differential-shellcheck or moving it somewhere else.
Thinking of the single responsibility principle we can keep them separate, I think I will have to implement an analog of src/summary.sh to get the output more readable in a terminal. This should allow not implementing redundant flags to control output styling and not adding the logic to stash/pop changes instead of checking out base/head commits.

[jamacku]

I agree that some work needs to be done to make differential shellcheck accessible from outside of GitHub Actions. My ultimate goal would be to make it possible to package it into distributions for local work.

• Enable to run Differential ShellCheck locally 🏙️  redhat-plumbers-in-action/differential-shellcheck#179

I want to thank you for working on pre-commit; it's awesome. I will leave you the choice of where to have it (pre-commit code). :-)

[mpoberezhniy]

I think I will be able to refactor it to have pre-commit and post-receive modes so pre-commit will be able to use it and the action will use it in a post-receive mode. This should help to get rid of the whole pre-commit.sh file and handling everything in index.sh while keeping the code readable.

If we have it as hooks - this should allow other SCM users to define their server-side hooks to trigger CI/CD and lint differentially.

[mpoberezhniy]

Disregarding the rest of todo since planning to get this into differential-shellcheck once it supports cli arguments.

[jamacku]

@mpoberezhniy I have already started working on CLI, but I have it only locally. As soon as it takes shape, I'll create a draft PR.