pre-commit-crocodile 2.0.1__tar.gz → 2.1.0__tar.gz

{pre_commit_crocodile-2.0.1 → pre_commit_crocodile-2.1.0}/.gitlab-ci.yml

@@ -70,6 +70,29 @@ changelog:
   rules:
     - if: $CI_LOCAL
 
+hooks:
+  stage: development
+  image: local:silent
+  script:
+    # Refresh configurations
+    - pre-commit-crocodile --configure
+    # Stash local changes
+    - echo ''
+    - echo ' [INFO] Use "s" to split hunks and "y" to remove changes you do not want, "n" otherwise'
+    - echo ''
+    - sleep 2
+    - git stash -p
+    # Stage changes
+    - git add -v ./.cz.yaml ./.pre-commit-config.yaml
+    # Enable hooks
+    - pre-commit-crocodile --enable
+    # Run hooks
+    - pre-commit-crocodile --run
+    # Reset changes
+    - git reset HEAD ./.cz.yaml ./.pre-commit-config.yaml
+  rules:
+    - if: $CI_LOCAL
+
 images:
   stage: development
   image: local:silent
@@ -156,7 +179,7 @@ preview:
     - project="${PWD}"
     - remote=$(git config --get remote.origin.url | sed 's#git@gitlab.com:#https://gitlab.com/#g')
     # Prepare package revision
-    - export DEBUG_REVISION_SHA=$(git rev-parse --short HEAD)
+    - export DEBUG_REVISION_SHA=$(git rev-parse --short origin/develop)
     # Create temporary sources
     - |
       sources=$(mktemp -d)
@@ -222,17 +245,21 @@ serve:
   script:
     # Prepare documentation
     - |
+      mkdir -p ./docs/.cache/
       ls -1 ./.cz.yaml ./docs/* ./mkdocs.yml ./README.md | entr sh ./docs/prepare.sh &
       echo -n "${!}" >./docs/.cache/.serve.pid
       sleep 2
     # Generate documentation
-    - network_ip=$(hostname -I | cut -d' ' -f1)
-    - mkdocs serve --dev-addr "${network_ip}:8001" --clean --config-file ./mkdocs.yml --verbose
-    # Release documentation
+    - |
+      network_ip=$(hostname -I | cut -d' ' -f1)
+      mkdocs serve --dev-addr "${network_ip}:8001" --clean --config-file ./mkdocs.yml --verbose || true
   after_script:
+    # Cleanup documentation
     - cat ./docs/.cache/.serve.pid | xargs -r kill >/dev/null 2>&1 || true
+    - rm -rf ./docs/.cache
   rules:
     - if: $CI_LOCAL
+  allow_failure: true
 
 # =============================================================================
 # Stage: prepare
@@ -244,7 +271,10 @@ codestyle:
   script:
     - yapf -i ./docs/*.py ./src/*.py ./src/*/*.py ./setup.py
     - echo '' && git diff --name-status
-    - git diff --quiet
+    - |
+      if [ -z "${CI_LOCAL:-}" ] || [ ! -z "${PRE_COMMIT}" ]; then
+        git diff --quiet
+      fi
   rules:
     - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
       changes:
@@ -667,6 +697,7 @@ pages:
     - sh ./docs/prepare.sh
     # Generate documentation
     - mkdocs build --clean --config-file ./mkdocs.yml --verbose
+  after_script:
     # Cleanup documentation
     - rm -rf ./docs/.cache
   artifacts:

{pre_commit_crocodile-2.0.1 → pre_commit_crocodile-2.1.0}/.pre-commit-config.yaml

@@ -12,7 +12,9 @@ minimum_pre_commit_version: 3.8.0
 # pre-commit exclusions
 exclude: >
   (?x)(
+    \.patch$|
     \.svg$|
+    eicar\..*$|
     CHANGELOG.md$|
     COPYING.*$|
     LICENSE.*$|
@@ -43,7 +45,8 @@ repos:
       - id: check-yaml
         args: ['--unsafe']
       - id: destroyed-symlinks
-      - id: detect-private-key
+        stages: [commit, push, manual] # Issue: https://github.com/pre-commit/pre-commit-hooks/pull/1085
+      # - id: detect-private-key
       - id: double-quote-string-fixer
       - id: end-of-file-fixer
       - id: mixed-line-ending
@@ -81,7 +84,7 @@ repos:
         description: Automatically run GitLab CI job with gcil (codestyle)
         stages:
           - pre-push
-        entry: gcil
+        entry: gcil -e 'PRE_COMMIT'
         args: ['codestyle']
         language: system
       - id: local-gcil-lint
@@ -89,7 +92,7 @@ repos:
         description: Automatically run GitLab CI job with gcil (lint)
         stages:
           - pre-push
-        entry: gcil
+        entry: gcil -e 'PRE_COMMIT'
         args: ['lint']
         language: system
       - id: local-gcil-typings
@@ -97,6 +100,6 @@ repos:
         description: Automatically run GitLab CI job with gcil (typings)
         stages:
           - pre-push
-        entry: gcil
+        entry: gcil -e 'PRE_COMMIT'
         args: ['typings']
         language: system

{pre_commit_crocodile-2.0.1 → pre_commit_crocodile-2.1.0}/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+<a name="2.1.0"></a>
+## [2.1.0](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/2.0.2...2.1.0) (2024-08-24)
+
+### ✨ Features
+
+- **entrypoint:** use 'pre-commit install --allow-missing-config' ([d41b2f3](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/d41b2f39d024ba14dde024ae021649b991631a0d))
+- **entrypoint:** use 'pre-commit run --all-files' parameter syntax ([956cb33](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/956cb333028e61d2e1e14b5971d233f4882d069a))
+- **pre-commit:** exclude '.patch' Git patch files from hooks ([e865955](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/e865955cc09781725dc0aa88314506b951ce3350))
+- **pre-commit:** disable 'detect-private-key' by default ([5ef6060](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/5ef6060fba92d46fde84530ccb08a271d50d2c94))
+- **pre-commit-config:** exclude 'eicar.*' Anti Malware Testfile ([6dbdb7c](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/6dbdb7c5c7727788ffd9974e8dc0dee8c9c0c467))
+
+### 🐛 Bug Fixes
+
+- **pre-commit:** fix 'destroyed-symlinks' v4.6.0 missing stages ([5377b8f](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/5377b8fc5349301a8c10cb24edf3e6d511626ddb))
+- **templates/commits:** avoid failing without 'local-gcil-*' hooks ([1d9dc15](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/1d9dc15b5fa3310251b35ab5f7f24398b2cfff93))
+
+### 📚 Documentation
+
+- **components:** add GitLab CI/CD Catalog for components URL ([47068c6](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/47068c6bce3758119db692ff74d0de9370ae199c))
+- **hooks:** fix hooks 'repo:' URL for '.pre-commit-config.yaml' ([b7c059e](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/b7c059ef2a72d307c629231606e836ade5564ec5))
+- **hooks:** improve hook '.pre-commit-config.yaml' documentation ([7a3c283](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/7a3c283ffb7c60bcdb9f9909c8b9194755982cfe))
+- **prepare:** fix 'Commit type' list faulty indentation issue ([42f49cb](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/42f49cb494c206752723df29996012ca4935e742))
+
+### ⚙️ Cleanups
+
+- **pre-commit:** fail 'gcil' jobs if 'PRE_COMMIT' is defined ([1fcb35c](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/1fcb35c0224b31a0641f138c784ca59a53da75b5))
+
+### 🚀 CI
+
+- **gitlab-ci:** improve 'serve' job syntax for YAML rendering ([aa41a7e](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/aa41a7e3544e40ede01733a83a9b9b936a8747e0))
+- **gitlab-ci:** cleanup cache upon 'serve' job end ([4574326](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/45743265d47b41929cebda731b444857feba9e14))
+- **gitlab-ci:** ignore 'serve' job failure due to 'Ctrl+C' end ([c8718b5](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/c8718b5257069ab7e5410bea086aecece90a39a3))
+- **gitlab-ci:** avoid failures of 'codestyle' upon local launches ([6660428](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/666042865a99dd49fd092abc13e06f3de039b887))
+
+
+<a name="2.0.2"></a>
+## [2.0.2](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/2.0.1...2.0.2) (2024-08-22)
+
+### 📚 Documentation
+
+- **components, hooks:** add file name headers for sources changes ([77cfb9b](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/77cfb9b4dc249e70811afc1161d4fefd170877e4))
+- **prepare:** bind 'preview.svg' image as a webpage asset ([2e214bd](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/2e214bdb63459c4265b035a6d86fe2e0ef69c1ef))
+- **preview:** add 'clear' calls before 'git add' sections ([8dd763c](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/8dd763c308e2319ea48c771fcb0abebdaa58f591))
+- **preview:** fix SVG preview for version 2.0.1 ([1d34359](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/1d34359768b881efd1a6ee3a0ec9a17f9fac17be))
+- **readme:** remove '{ ... }' wrappers for single commands ([dd892d8](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/dd892d8233f304b4b24cf3475f6c24f2a1e1ce5d))
+- **readme:** simplify and cleanup commands documentation ([d2d3b38](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/d2d3b38a87780524bcd56a41ca52b8276f633553))
+
+### 🚀 CI
+
+- **gitlab-ci:** create 'hooks' local job for maintenance ([df35dc9](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/df35dc992f811dbd35981d59643c7d20b51d20c0))
+- **gitlab-ci:** prepare and remove '.cache' even upon failures ([f56f38e](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/f56f38e29e33877871ce1cc538e569374e1fa349))
+- **gitlab-ci:** use 'origin/develop' as hooks revision for 'preview' ([9c0c29c](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commit/9c0c29c353297c8ec21329ea3dfec3b1187c708a))
+
+
 <a name="2.0.1"></a>
 ## [2.0.1](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/compare/2.0.0...2.0.1) (2024-08-21)
 

{pre_commit_crocodile-2.0.1/pre_commit_crocodile.egg-info → pre_commit_crocodile-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pre-commit-crocodile
-Version: 2.0.1
+Version: 2.1.0
 Summary: Git hooks intended for developers using pre-commit
 Home-page: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile
 Author: Adrian DC
@@ -64,7 +64,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ## Preview
 
-![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.1/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.1.0/docs/preview.svg)
 
 ---
 
@@ -131,10 +131,7 @@ positional arguments:
 ### Import configurations
 
 ```bash
-{
-  # Disable hooks
-  pre-commit-crocodile --configure
-}
+pre-commit-crocodile --configure
 ```
 
 ---
@@ -144,46 +141,31 @@ positional arguments:
 ### Install dependencies
 
 ```bash
-{
-  # Install dependencies
-  pre-commit-crocodile --install
-}
+pre-commit-crocodile --install
 ```
 
 ### Enable hooks
 
 ```bash
-{
-  # Enable hooks
-  pre-commit-crocodile --enable
-}
+pre-commit-crocodile --enable
 ```
 
 ### Run hooks
 
 ```bash
-{
-  # Manually run hooks
-  pre-commit-crocodile --run
-}
+pre-commit-crocodile --run
 ```
 
 ### Update hooks
 
 ```bash
-{
-  # Autoupdate hooks
-  pre-commit-crocodile --autoupdate
-}
+pre-commit-crocodile --autoupdate
 ```
 
 ### Disable hooks
 
 ```bash
-{
-  # Disable hooks
-  pre-commit-crocodile --disable
-}
+pre-commit-crocodile --disable
 ```
 
 ---

{pre_commit_crocodile-2.0.1 → pre_commit_crocodile-2.1.0}/README.md

@@ -32,7 +32,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ## Preview
 
-![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.0.1/docs/preview.svg)
+![preview.svg](https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile/raw/2.1.0/docs/preview.svg)
 
 ---
 
@@ -99,10 +99,7 @@ positional arguments:
 ### Import configurations
 
 ```bash
-{
-  # Disable hooks
-  pre-commit-crocodile --configure
-}
+pre-commit-crocodile --configure
 ```
 
 ---
@@ -112,46 +109,31 @@ positional arguments:
 ### Install dependencies
 
 ```bash
-{
-  # Install dependencies
-  pre-commit-crocodile --install
-}
+pre-commit-crocodile --install
 ```
 
 ### Enable hooks
 
 ```bash
-{
-  # Enable hooks
-  pre-commit-crocodile --enable
-}
+pre-commit-crocodile --enable
 ```
 
 ### Run hooks
 
 ```bash
-{
-  # Manually run hooks
-  pre-commit-crocodile --run
-}
+pre-commit-crocodile --run
 ```
 
 ### Update hooks
 
 ```bash
-{
-  # Autoupdate hooks
-  pre-commit-crocodile --autoupdate
-}
+pre-commit-crocodile --autoupdate
 ```
 
 ### Disable hooks
 
 ```bash
-{
-  # Disable hooks
-  pre-commit-crocodile --disable
-}
+pre-commit-crocodile --disable
 ```
 
 ---

{pre_commit_crocodile-2.0.1 → pre_commit_crocodile-2.1.0}/docs/components.md

@@ -16,6 +16,12 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ---
 
+## CI/CD components
+
+**GitLab CI/CD Catalog:** <https://gitlab.com/explore/catalog/RadianDevCore/tools/pre-commit-crocodile>
+
+---
+
 ### `commits` - GitLab CI job to validate newly pushed commits
 
 **Validate commits added on a branch or for a merge request :**
@@ -25,9 +31,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 - **Run pre-commit checks** on all files
 - **Deny `WIP` commits** on GitLab branches
 
-**Changes to `.gitlab-ci.yml` :**
-
-```yaml
+```yaml title="Sources / .gitlab-ci.yml"
 include:
   - component: gitlab.com/RadianDevCore/tools/pre-commit-crocodile/commits@X.Y.Z # Adapt to latest release tag
     inputs:

{pre_commit_crocodile-2.0.1 → pre_commit_crocodile-2.1.0}/docs/hooks.md

@@ -18,9 +18,7 @@ Git hooks intended for developers using [pre-commit](https://pre-commit.com/) an
 
 ## Using pre-commit-crocodile hooks
 
-**Changes to `.pre-commit-config.yaml` :**
-
-```yaml
+```yaml title="Sources / .pre-commit-config.yaml"
 # pre-commit configurations
 default_install_hook_types:
   - prepare-commit-msg
@@ -36,7 +34,7 @@ minimum_pre_commit_version: 3.8.0
 repos:
 
   # Repository: pre-commit-crocodile
-  - repo: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile.git
+  - repo: https://gitlab.com/RadianDevCore/tools/pre-commit-crocodile
     rev: X.Y.Z # Adapt to latest release tag
     hooks:
       - id: ...
@@ -46,22 +44,20 @@ repos:
 
 ### `prepare-commit-message` - Prepare commit message automatically
 
+```yaml title="Sources / .pre-commit-config.yaml"
+  # Repository: pre-commit-crocodile
+  - repo: ...
+    ...
+    hooks:
+      - id: prepare-commit-message
+```
+
 **Automatically prepare the commit message based on changed sources before manual edition :**
 
 - **Launched automatically by Git** upon `prepare-commit-msg` stage using `pre-commit`
-- Parse `Changes to be committed:` **to automatically prepare a `type(scope): ...` helpful template**
+- Parse `Changes to be committed:` **to automatically prepare a `type(scope): ...` title**
 - Commit messages implementation derived from **[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specifications**
 - **Automatically detect and prepare templates like `ci(gitlab-ci):`, `docs(readme):`, `build(makefile):` or `docs(changelog):`**
 - **Automatically evaluate sources specific scopes, for example files or folders under `src/`, or recipe folders in Yocto `recipes-.../` sources**
 - Message body is automatically inserted to help developers document their commits or link to a related issue
 - Commits with sign-off messages automatically receive a `---` separator for readability on GitLab
-
-**Changes to `.pre-commit-config.yaml` :**
-
-```yaml
-  # Repository: pre-commit-crocodile
-  - repo: ...
-    ...
-    hooks:
-      - id: prepare-commit-message
-```

{pre_commit_crocodile-2.0.1 → pre_commit_crocodile-2.1.0}/docs/prepare.sh

@@ -12,8 +12,14 @@ rm -f "${docs_path}/.cache/*.md"
 mkdir -p "${docs_path}/.cache/"
 cp -rfv "${docs_path}/"*.md "${docs_path}/.cache/"
 
+# Export assets
+rm -rf "${docs_path}/.cache/assets/images"
+mkdir -p "${docs_path}/.cache/assets/images/"
+cp -f "${root_path}/docs/preview.svg" "${docs_path}/.cache/assets/images/"
+
 # Export usage
 cp -f "${root_path}/README.md" "${docs_path}/.cache/index.md"
+sed -i "s#\(\[.*\]\)(.*/docs/#\1(assets/images/#g" "${docs_path}/.cache/index.md"
 
 # Export commits
 {
@@ -32,7 +38,7 @@ cp -f "${root_path}/README.md" "${docs_path}/.cache/index.md"
     -e 's/\(conventional commits\|semantic versioning\)/**\1**/g' \
     -e "s/ '\([A-Za-z0-9:!]\{1,\}\)' / **\`\1\`** /g" \
     -e 's/^\([^#]\{1,\}\)$/\1  /g' \
-    -e '/^[^#\[<]\{1\}[^`]\{1,\}/s/^/\&nbsp;\&nbsp;\&nbsp;\&nbsp; /g'
+    -e '/^[^#\[<-]\{1\}[^`]\{1,\}/s/^/\&nbsp;\&nbsp;\&nbsp;\&nbsp; /g'
   echo ''
   echo '---'
   echo ''

{pre_commit_crocodile-2.0.1 → pre_commit_crocodile-2.1.0}/docs/preview.py

@@ -45,6 +45,11 @@ Executor('pre-commit-crocodile --run',
     wait(1).\
     finish()
 
+# Clear terminal
+Executor('clear',
+         delay_init=0.1, delay_prompt=2.0).\
+    finish()
+
 # Add hooks changes
 Executor('git add -v ./.cz.yaml ./.pre-commit-config.yaml',
          delay_init=0.1, delay_prompt=1.0).\
@@ -57,6 +62,11 @@ Executor('git commit -m "chore(pre-commit): import \'pre-commit-crocodile\' conf
     wait(1).\
     finish()
 
+# Clear terminal
+Executor('clear',
+         delay_init=0.1, delay_prompt=2.0).\
+    finish()
+
 # Add first changes
 Executor('git add -p ./docs/',
          delay_init=0.1, delay_press=0.2, delay_prompt=1.0).\
@@ -108,6 +118,11 @@ Executor('git show',
     wait(1).\
     finish()
 
+# Clear terminal
+Executor('clear',
+         delay_init=0.1, delay_prompt=2.0).\
+    finish()
+
 # Add second changes
 Executor('git add -p ./src/',
          delay_init=0.1, delay_press=0.2, delay_prompt=1.0).\