[stable/NONE] Disable PR Title Checker github action, update README (…

…deliveryhero#575) * disable PR title checker * update readme * update github PR title check * MD lint --------- Co-authored-by: Max Williams <[email protected]>
gastromatic · Oct 23, 2024 · 44b6ad8 · 44b6ad8
1 parent 3c7db93
commit 44b6ad8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/.github/workflows/check_pr.yaml b/.github/workflows/check_pr.yaml
@@ -15,5 +15,5 @@ jobs:
         uses: actions/checkout@v2
       - uses: deepakputhraya/action-pr-title@master
         with:
-          regex: '^\[stable\/+.+]\s.+'
+          regex: '^\[stable\/+.+].*'
           prefix_case_sensitive: false
diff --git a/README.md b/README.md
@@ -118,16 +118,17 @@ All commands to be run from the root of this repo.
 
 `helm-docs`:
 
-  To generate chart `README.md` files from the [template](ci/README.md.gotmpl):
+  To generate chart `README.md` files from the [template](ci/README.md.gotmpl), you can run `helm-docs` via docker:
 
   ```console
-  <!-- docker -->
   docker run --rm -v "${PWD}:/helm-docs" jnorwood/helm-docs:v1.11.3 --template-files ./ci/README.md.gotmpl
-  <!-- pre-commit -->
-  # install pre-commit https://pre-commit.com/#install
-  $ brew install pre-commit
-  $  pre-commit install
-  $ pre-commit install-hooks
+  ```
+
+  Or alternatively install via [pre-commit](https://pre-commit.com/#install):
+
+  ```console
+  pre-commit install
+  pre-commit install-hooks
   ```
 
 `helm-conftest`: