From f73a5a0fcb474b7e18c4e786d1c43e6af5f82e6c Mon Sep 17 00:00:00 2001 From: klinch0 <68821526+klinch0@users.noreply.github.com> Date: Mon, 2 Dec 2024 21:24:22 +0300 Subject: [PATCH] add make-generate to pre-commit (#491) ## Summary by CodeRabbit - **New Features** - Introduced a new pre-commit hook (`run-make-generate`) to automate the generation process in application directories. - **Documentation** - Enhanced readability of the Managed NATS Service README by adjusting formatting and removing unnecessary headers. - **Bug Fixes** - Corrected JSON structure in the Postgres values schema to ensure validity. - **Chores** - Updated pre-commit configuration for improved consistency and functionality. - Reorganized properties in the NATS values schema, removing the `users` property to reflect changes in user management capabilities. --- .github/workflows/pre-commit.yml | 12 +++++++ .pre-commit-config.yaml | 17 +++++++-- packages/apps/nats/README.md | 7 +--- packages/apps/nats/values.schema.json | 44 ++++++++--------------- packages/apps/postgres/values.schema.json | 2 +- 5 files changed, 44 insertions(+), 38 deletions(-) diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index ddfc2de8..ffb8813f 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -17,6 +17,18 @@ jobs: - name: Install pre-commit run: pip install pre-commit + - name: Install generate + run: | + sudo apt update + sudo apt install curl -y + curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash - + sudo apt install nodejs -y + git clone https://github.com/bitnami/readme-generator-for-helm + cd ./readme-generator-for-helm + npm install + npm install -g pkg + pkg . -o /usr/local/bin/readme-generator + - name: Run pre-commit hooks run: | git fetch origin main || git fetch origin master diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 9939cc79..6d05ad6f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: -- repo: local - hooks: +- repo: local + hooks: - id: gen-versions-map name: Generate versions map and check for changes entry: sh -c 'make -C packages/apps check-version-map && make -C packages/extra check-version-map' @@ -8,3 +8,16 @@ repos: types: [file] pass_filenames: false description: Run the script and fail if it generates changes + - id: run-make-generate + name: Run 'make generate' in all app directories + entry: | + /bin/bash -c ' + for dir in ./packages/apps/*/; do + if [ -d "$dir" ]; then + echo "Running make generate in $dir" + (cd "$dir" && make generate) + fi + done + ' + language: script + files: ^.*$ diff --git a/packages/apps/nats/README.md b/packages/apps/nats/README.md index 19ed3ae0..96a59def 100644 --- a/packages/apps/nats/README.md +++ b/packages/apps/nats/README.md @@ -9,9 +9,4 @@ | `external` | Enable external access from outside the cluster | `false` | | `replicas` | Persistent Volume size for NATS | `2` | | `storageClass` | StorageClass used to store the data | `""` | - -### Configuration parameters - -| Name | Description | Value | -| ----------- | ----------------------- | ----- | -| `users` | Users configuration | `{}` | +| `users` | Users configuration | `{}` | diff --git a/packages/apps/nats/values.schema.json b/packages/apps/nats/values.schema.json index d8ff291e..df176502 100644 --- a/packages/apps/nats/values.schema.json +++ b/packages/apps/nats/values.schema.json @@ -2,34 +2,20 @@ "title": "Chart Values", "type": "object", "properties": { - "external": { - "type": "boolean", - "description": "Enable external access from outside the cluster", - "default": false - }, - "replicas": { - "type": "number", - "description": "Persistent Volume size for NATS", - "default": 2 - }, - "storageClass": { - "type": "string", - "description": "StorageClass used to store the data", - "default": "" - }, - "users": { - "type": "object", - "description": "Users configuration", - "additionalProperties": { - "type": "object", - "properties": { - "password": { - "type": "string", - "description": "Password for the user" - } - } + "external": { + "type": "boolean", + "description": "Enable external access from outside the cluster", + "default": false }, - "default": {} - } + "replicas": { + "type": "number", + "description": "Persistent Volume size for NATS", + "default": 2 + }, + "storageClass": { + "type": "string", + "description": "StorageClass used to store the data", + "default": "" + } } - } +} \ No newline at end of file diff --git a/packages/apps/postgres/values.schema.json b/packages/apps/postgres/values.schema.json index c63184ca..b5214b3f 100644 --- a/packages/apps/postgres/values.schema.json +++ b/packages/apps/postgres/values.schema.json @@ -103,4 +103,4 @@ } } } -} +} \ No newline at end of file