Skip to content

Commit

Permalink
[stable/NONE] Disable PR Title Checker github action, update README (
Browse files Browse the repository at this point in the history
…#575)

* disable PR title checker

* update readme

* update github PR title check

* MD lint

---------

Co-authored-by: Max Williams <max-rocket-internet@users.noreply.github.com>
  • Loading branch information
max-rocket-internet and max-rocket-internet committed Apr 8, 2024
1 parent 19e7766 commit e24b5c6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/check_pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down

0 comments on commit e24b5c6

Please sign in to comment.