Commit 0834c660 authored by nimrod's avatar nimrod
Browse files

pre-commit. 

Add common Docker checks, address some issues.
parent 8b9c8afa

.pre-commit-config.yaml

0 → 100644
+49 −0
Original line number Diff line number Diff line 
---

repos:

  - repo: https://github.com/pre-commit/pre-commit-hooks.git

    rev: v3.4.0

    hooks:

      - id: check-added-large-files

      - id: check-executables-have-shebangs

      - id: check-merge-conflict

      - id: check-symlinks

      - id: trailing-whitespace



  - repo: https://github.com/Yelp/detect-secrets

    rev: v0.14.3

    hooks:

      - id: detect-secrets



  - repo: https://github.com/adrienverge/yamllint

    rev: v1.25.0

    hooks:

      - id: yamllint



  - repo: https://github.com/amperser/proselint/

    rev: 0.10.2

    hooks:

      - id: proselint

        types: [plain-text]

        exclude: LICENSE|example



  - repo: https://github.com/executablebooks/mdformat.git

    rev: 0.5.3

    hooks:

      - id: mdformat

        exclude: example



  - repo: https://git.shore.co.il/nimrod/shell-pre-commit.git

    rev: v0.6.0

    hooks:

      - id: shell-lint



  - repo: https://github.com/shellcheck-py/shellcheck-py.git

    rev: v0.7.1.1

    hooks:

      - id: shellcheck



  - repo: https://git.shore.co.il/nimrod/docker-pre-commit.git/

    rev: v0.3.0

    hooks:

      - id: hadolint

      - id: docker-compose

Dockerfile

+1 −0
Original line number Diff line number Diff line
@@ -4,6 +4,7 @@ RUN go get github.com/spelufo/on-change && \ 


FROM debian:buster-slim

COPY --from=golang /go/bin/on-change /go/bin/ttyrec2gif /usr/local/bin/

# hadolint ignore=DL3008

RUN apt-get update && \

    DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \

        ca-certificates \

README.md

+7 −7
Original line number Diff line number Diff line
@@ -5,11 +5,11 @@ Markdown or DOT). 


## Usage



`docker run --rm -itv "$PWD:/volume" adarnimrod/presentation`

`docker run --rm -itv “$PWD:/volume“ adarnimrod/presentation`



Will watch the current directory and run `make` whenever a file changes. One can

add a shell alias `alias presentation='docker run --rm -itv "$PWD:/volume"

adarnimrod/presentation'` for easier use.

add a shell alias

`alias presentation='docker run --rm -itv “$PWD:/volume“ adarnimrod/presentation'` for easier use.



See the example folder for more details.
@@ -31,7 +31,7 @@ This software is licensed under the MIT license (see `LICENSE.txt`). 


## Author Information



Nimrod Adar, [contact me](mailto:nimrod@shore.co.il) or visit my [website](

https://www.shore.co.il/). Patches are welcome via [`git send-email`](

http://git-scm.com/book/en/v2/Git-Commands-Email). The repository is located

at: <https://www.shore.co.il/git/>.
 
Nimrod Adar, [contact me](mailto:nimrod@shore.co.il) or visit my

[website](https://www.shore.co.il/). Patches are welcome via

[`git send-email`](http://git-scm.com/book/en/v2/Git-Commands-Email). The repository

is located at: <https://git.shore.co.il/expore/>.