From 48e9ed9688b04e7c4a67ad009c3ab2676025aefc Mon Sep 17 00:00:00 2001 From: Sorin Sbarnea Date: Mon, 17 Jun 2024 17:14:15 +0100 Subject: [PATCH] Avoid using docker_image pre-commit hook (portability) (#218) Related: https://github.com/pre-commit/pre-commit/issues/2920 --- .github/SECURITY.md | 5 +++-- .gitignore | 2 +- .pre-commit-config.yaml | 10 +++------- docs/README.md | 9 +++++---- 4 files changed, 12 insertions(+), 14 deletions(-) diff --git a/.github/SECURITY.md b/.github/SECURITY.md index fd7feeb..d33273a 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -6,5 +6,6 @@ The only supported version is the latest release. ## Reporting a Vulnerability -Send an email to sorin.sbarnea@gmail.com if you found any security -vulnerability that is better to not have a public bug raise right away. +Use [github reporting](https://github.com/pycontribs/mk/security) if you +found any security vulnerability that is better to not have a public bug raised +right away. diff --git a/.gitignore b/.gitignore index 63b0aee..c22da3f 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,6 @@ report.html site src/mk.egg-info src/mk/_version.py -.coverage +.coverage* coverage.xml CMakeFiles diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 37ace9d..3d95272 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,7 +1,4 @@ --- -ci: - skip: - - markdownlint_docker repos: - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.4.9 @@ -26,11 +23,10 @@ repos: # entry: codespell --relative args: [--relative, --no-progress, --no-summary] name: Spell check with cspell - - - repo: https://github.com/markdownlint/markdownlint.git - rev: v0.12.0 + - repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.41.0 hooks: - - id: markdownlint_docker + - id: markdownlint - repo: https://github.com/psf/black rev: 24.4.2 hooks: diff --git a/docs/README.md b/docs/README.md index 30dbc92..a56571d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,9 +20,10 @@ configuration file is needed as the tool will look for common tools used by the repository and expose their commands. `mk` is inspired by tools such [make][make], [waf][waf], [taskfile][taskfile], -[tox][tox], [npm][npm], [yarn][yarn] and [pre-commit][pre-commit], but **it does -not aim to replace them**. Instead, it aims to provide a unified interface for -calling them that is friendly even for those that never used these tools. +[tox][tox], [nox][nox], [npm][npm], [yarn][yarn] and [pre-commit][pre-commit], +but **it does not aim to replace them**. Instead, it aims to provide a unified +interface for calling them that is friendly even for those that never used +these tools. ## Installation @@ -101,7 +102,7 @@ status or that the testing did not leave untracked files. unknown. (#20) - Configuration file where additional actions can be added. (#21) - Dependencies between commands. While some tools support dependencies, many do - not. You should be able to declare that a specific command would run only + not. You should be able to declare that a specific command will run only after another one already passed. (#22) - Ability to generate CI/CD pipelines so the user would spend less time writing non-portable configurations. (#23)