diff --git a/helm/readme-generator-config.json b/helm/readme-generator-config.json deleted file mode 100644 index a0ade9c..0000000 --- a/helm/readme-generator-config.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "comments": { - "format": "#" - }, - "tags": { - "param": "@param", - "section": "@section", - "skip": "@skip", - "extra": "@extra" - }, - "modifiers": { - "array": "array", - "object": "object", - "string": "string" - }, - "regexp": { - "paramsSectionTitle": "Parameters" - } -} diff --git a/helm/values.yaml b/helm/values.yaml index d76e407..4ecf6bb 100644 --- a/helm/values.yaml +++ b/helm/values.yaml @@ -1,32 +1,32 @@ -# @section Common parameters +## @section Common parameters -# @param replicaCount Number of replicas for the bot +## @param replicaCount Number of replicas for the bot replicaCount: 1 -# ref: https://hub.docker.com/r/justusbunsi/gitea-sonarqube-bot/tags/ -# @param image.repository Image repository -# @param image.pullPolicy Image pull policy -# @param image.tag Image tag (Overrides the image tag whose default is the chart `appVersion`) +## ref: https://hub.docker.com/r/justusbunsi/gitea-sonarqube-bot/tags/ +## @param image.repository Image repository +## @param image.pullPolicy Image pull policy +## @param image.tag Image tag (Overrides the image tag whose default is the chart `appVersion`) image: repository: justusbunsi/gitea-sonarqube-bot pullPolicy: IfNotPresent tag: "" -# @param imagePullSecrets Specify docker-registry secret names as an array +## @param imagePullSecrets Specify docker-registry secret names as an array imagePullSecrets: [] -# @param nameOverride String to partially override common.names.fullname template (will maintain the release name) +## @param nameOverride String to partially override common.names.fullname template (will maintain the release name) nameOverride: "" -# @param fullnameOverride String to fully override common.names.fullname template +## @param fullnameOverride String to fully override common.names.fullname template fullnameOverride: "" -# We usually recommend not to specify default resources and to leave this as a conscious -# choice for the user. This also increases chances charts run on environments with little -# resources, such as Minikube. If you do want to specify resources, uncomment the following -# lines, adjust them as necessary, and remove the curly braces after 'resources:'. -# @param resources.limits The resources limits for the container -# @param resources.requests The requested resources for the container +## We usually recommend not to specify default resources and to leave this as a conscious +## choice for the user. This also increases chances charts run on environments with little +## resources, such as Minikube. If you do want to specify resources, uncomment the following +## lines, adjust them as necessary, and remove the curly braces after 'resources:'. +## @param resources.limits The resources limits for the container +## @param resources.requests The requested resources for the container resources: limits: {} # cpu: 100m @@ -35,110 +35,110 @@ resources: # cpu: 100m # memory: 128Mi -# @param nodeSelector Node labels for pod assignment. Evaluated as a template. -# ref: https://kubernetes.io/docs/user-guide/node-selection/ +## @param nodeSelector Node labels for pod assignment. Evaluated as a template. +## ref: https://kubernetes.io/docs/user-guide/node-selection/ nodeSelector: {} -# @param tolerations Tolerations for pod assignment. Evaluated as a template. -# ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ +## @param tolerations Tolerations for pod assignment. Evaluated as a template. +## ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ tolerations: [] -# @param affinity Affinity for pod assignment. Evaluated as a template. -# ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity +## @param affinity Affinity for pod assignment. Evaluated as a template. +## ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity affinity: {} -# @param podAnnotations Pod annotations. +## @param podAnnotations Pod annotations. podAnnotations: {} -# @section App parameters +## @section App parameters app: - # @param app.configLocationOverride Override the default location of the configuration file (`/home/bot/config/config.yaml`). **Available since Chart version `0.2.0`. Requires at least image tag `v0.2.0`**. (See values file for details) - # Setting this will also change the mount point for `.Values.app.configuration` to the directory part of the override value. + ## @param app.configLocationOverride Override the default location of the configuration file (`/home/bot/config/config.yaml`). **Available since Chart version `0.2.0`. Requires at least image tag `v0.2.0`**. (See values file for details) + ## Setting this will also change the mount point for `.Values.app.configuration` to the directory part of the override value. configLocationOverride: "" - # @param app.listeningPort Port the application will listening on inside the pod container. **Available since Chart version `0.2.1`. Requires at least image tag `v0.2.1`**. + ## @param app.listeningPort Port the application will listening on inside the pod container. **Available since Chart version `0.2.1`. Requires at least image tag `v0.2.1`**. listeningPort: 3000 - # This object represents the [config.yaml](https://codeberg.org/justusbunsi/gitea-sonarqube-bot/src/branch/main/config/config.example.yaml) provided to the application. + ## This object represents the [config.yaml](https://codeberg.org/justusbunsi/gitea-sonarqube-bot/src/branch/main/config/config.example.yaml) provided to the application. configuration: - # Gitea related configuration. Necessary for adding/updating comments on repository pull requests + ## Gitea related configuration. Necessary for adding/updating comments on repository pull requests gitea: - # @param app.configuration.gitea.url Endpoint of your Gitea instance. Must be expandable by '/api/v1' to form the API base path as shown in Swagger UI. + ## @param app.configuration.gitea.url Endpoint of your Gitea instance. Must be expandable by '/api/v1' to form the API base path as shown in Swagger UI. url: "" - # Created access token for the user that shall be used as bot account. - # User needs "Read project" permissions with access to "Pull Requests" - # @param app.configuration.gitea.token.value Gitea token as plain text. Can be replaced with `file` key containing path to file. + ## Created access token for the user that shall be used as bot account. + ## User needs "Read project" permissions with access to "Pull Requests" + ## @param app.configuration.gitea.token.value Gitea token as plain text. Can be replaced with `file` key containing path to file. token: value: "" # # or path to file containing the plain text secret # file: /bot/secrets/gitea/user-token - # If the sent webhook has a signature header, the bot validates the request payload. If the value does not match, the - # request will be ignored. - # The bot looks for `X-Gitea-Signature` header containing the sha256 hmac hash of the plain text secret. If the header - # exists and no webhookSecret is defined here, the bot will ignore the request, because it cannot be validated. - # @param app.configuration.gitea.webhook.secret Secret for signature header (in plaintext) - # @extra app.configuration.gitea.webhook.secretFile Path to file containing the plain text secret. Alternative to inline `app.configuration.gitea.webhook.secret` + ## If the sent webhook has a signature header, the bot validates the request payload. If the value does not match, the + ## request will be ignored. + ## The bot looks for `X-Gitea-Signature` header containing the sha256 hmac hash of the plain text secret. If the header + ## exists and no webhookSecret is defined here, the bot will ignore the request, because it cannot be validated. + ## @param app.configuration.gitea.webhook.secret Secret for signature header (in plaintext) + ## @extra app.configuration.gitea.webhook.secretFile Path to file containing the plain text secret. Alternative to inline `app.configuration.gitea.webhook.secret` webhook: secret: "" # # or path to file containing the plain text secret # secretFile: /bot/secrets/gitea/webhook-secret - # SonarQube related configuration. Necessary for requesting data from the API and processing the webhook. + ## SonarQube related configuration. Necessary for requesting data from the API and processing the webhook. sonarqube: - # @param app.configuration.sonarqube.url Endpoint of your SonarQube instance. Must be expandable by '/api' to form the API base path. + ## @param app.configuration.sonarqube.url Endpoint of your SonarQube instance. Must be expandable by '/api' to form the API base path. url: "" - # Created access token for the user that shall be used as bot account. - # User needs "Browse on project" permissions - # @param app.configuration.sonarqube.token.value SonarQube token as plain text. Can be replaced with `file` key containing path to file. + ## Created access token for the user that shall be used as bot account. + ## User needs "Browse on project" permissions + ## @param app.configuration.sonarqube.token.value SonarQube token as plain text. Can be replaced with `file` key containing path to file. token: value: "" # # or path to file containing the plain text secret # file: /bot/secrets/sonarqube/user-token - # If the sent webhook has a signature header, the bot validates the request payload. If the value does not match, the - # request will be ignored. - # The bot looks for `X-Sonar-Webhook-HMAC-SHA256` header containing the sha256 hmac hash of the plain text secret. - # If the header exists and no webhookSecret is defined here, the bot will ignore the request, because it cannot be - # validated. - # @param app.configuration.sonarqube.webhook.secret Secret for signature header (in plaintext) - # @extra app.configuration.sonarqube.webhook.secretFile Path to file containing the plain text secret. Alternative to inline `app.configuration.sonarqube.webhook.secret` + ## If the sent webhook has a signature header, the bot validates the request payload. If the value does not match, the + ## request will be ignored. + ## The bot looks for `X-Sonar-Webhook-HMAC-SHA256` header containing the sha256 hmac hash of the plain text secret. + ## If the header exists and no webhookSecret is defined here, the bot will ignore the request, because it cannot be + ## validated. + ## @param app.configuration.sonarqube.webhook.secret Secret for signature header (in plaintext) + ## @extra app.configuration.sonarqube.webhook.secretFile Path to file containing the plain text secret. Alternative to inline `app.configuration.sonarqube.webhook.secret` webhook: secret: "" # # or path to file containing the plain text secret # secretFile: /bot/secrets/sonarqube/webhook-secret - # Some useful metrics depend on the edition in use. There are various ones like code_smells, vulnerabilities, bugs, etc. - # By default the bot will extract "bugs,vulnerabilities,code_smells" - # @param app.configuration.sonarqube.additionalMetrics Setting this option you can extend that default list by your own metrics. + ## Some useful metrics depend on the edition in use. There are various ones like code_smells, vulnerabilities, bugs, etc. + ## By default the bot will extract "bugs,vulnerabilities,code_smells" + ## @param app.configuration.sonarqube.additionalMetrics Setting this option you can extend that default list by your own metrics. additionalMetrics: [] # - "new_security_hotspots" - # List of project mappings to take care of. Webhooks for other projects will be ignored. - # At least one must be configured. Otherwise all webhooks (no matter which source) because the bot cannot map on its own. - # @param app.configuration.projects[0].sonarqube.key Project key inside SonarQube - # @param app.configuration.projects[0].gitea.owner Repository owner inside Gitea - # @param app.configuration.projects[0].gitea.name Repository name inside Gitea + ## List of project mappings to take care of. Webhooks for other projects will be ignored. + ## At least one must be configured. Otherwise all webhooks (no matter which source) because the bot cannot map on its own. + ## @param app.configuration.projects[0].sonarqube.key Project key inside SonarQube + ## @param app.configuration.projects[0].gitea.owner Repository owner inside Gitea + ## @param app.configuration.projects[0].gitea.name Repository name inside Gitea projects: - sonarqube: key: "" - # A repository specification contains the owner name and the repository name itself. The owner can be the name of a - # real account or an organization in which the repository is located. + ## A repository specification contains the owner name and the repository name itself. The owner can be the name of a + ## real account or an organization in which the repository is located. gitea: owner: "" name: "" - # Define pull request names from SonarScanner analysis. Default pattern matches the Jenkins Gitea plugin schema. - # @param app.configuration.namingPattern.regex Regular expression that MUST HAVE exactly ONE GROUP that matches the integer part of the PR. That integer part is identical to the pull request ID in Gitea. - # @param app.configuration.namingPattern.template Valid Go format string. It MUST have one integer placeholder which will be replaced by the pull request ID. See: https://pkg.go.dev/fmt#hdr-Printing + ## Define pull request names from SonarScanner analysis. Default pattern matches the Jenkins Gitea plugin schema. + ## @param app.configuration.namingPattern.regex Regular expression that MUST HAVE exactly ONE GROUP that matches the integer part of the PR. That integer part is identical to the pull request ID in Gitea. + ## @param app.configuration.namingPattern.template Valid Go format string. It MUST have one integer placeholder which will be replaced by the pull request ID. See: https://pkg.go.dev/fmt#hdr-Printing namingPattern: regex: "^PR-(\\d+)$" template: "PR-%d" -# @param volumes If token and webhook secrets shall be provided via file, volumes and volume mounts can be configured to setup the environment accordingly +## @param volumes If token and webhook secrets shall be provided via file, volumes and volume mounts can be configured to setup the environment accordingly volumes: [] # - name: gitea-connection # secret: @@ -147,7 +147,7 @@ volumes: [] # secret: # secretName: sonarqube-secret-with-token-and-maybe-webhook-secret -# @param volumeMounts If token and webhook secrets shall be provided via file, volumes and volume mounts can be configured to setup the environment accordingly +## @param volumeMounts If token and webhook secrets shall be provided via file, volumes and volume mounts can be configured to setup the environment accordingly volumeMounts: [] # - name: gitea-connection # readOnly: true @@ -156,25 +156,25 @@ volumeMounts: [] # readOnly: true # mountPath: "/bot/secrets/sonarqube/" -# @section Security parameters +## @section Security parameters serviceAccount: - # @param serviceAccount.create Specifies whether a service account should be created + ## @param serviceAccount.create Specifies whether a service account should be created create: true - # @param serviceAccount.annotations Annotations to add to the service account + ## @param serviceAccount.annotations Annotations to add to the service account annotations: {} - # @param serviceAccount.name The name of the service account to use. If not set and create is true, a name is generated using the fullname template + ## @param serviceAccount.name The name of the service account to use. If not set and create is true, a name is generated using the fullname template name: "" -# ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod -# @param podSecurityContext.fsGroup Group ID for the container +## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod +## @param podSecurityContext.fsGroup Group ID for the container podSecurityContext: fsGroup: 1000 -# ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container -# @param securityContext.readOnlyRootFilesystem Mounts the container's root filesystem as read-only -# @param securityContext.runAsNonRoot Avoid running as root user -# @param securityContext.runAsUser User ID for the container +## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container +## @param securityContext.readOnlyRootFilesystem Mounts the container's root filesystem as read-only +## @param securityContext.runAsNonRoot Avoid running as root user +## @param securityContext.runAsUser User ID for the container securityContext: # capabilities: # drop: @@ -183,41 +183,41 @@ securityContext: runAsNonRoot: true runAsUser: 1000 -# @section Traffic exposure parameters +## @section Traffic exposure parameters -# @param service.type Service type -# @param service.port Service port +## @param service.type Service type +## @param service.port Service port service: type: ClusterIP port: 80 -# ref: https://kubernetes.io/docs/user-guide/ingress/ +## ref: https://kubernetes.io/docs/user-guide/ingress/ ingress: - # @param ingress.enabled Enable ingress controller resource + ## @param ingress.enabled Enable ingress controller resource enabled: false - # @param ingress.className IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) - # This is supported in Kubernetes 1.18+ and required if you have more than one IngressClass marked as the default for your cluster. - # ref: https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/ + ## @param ingress.className IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) + ## This is supported in Kubernetes 1.18+ and required if you have more than one IngressClass marked as the default for your cluster. + ## ref: https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/ className: "" - # @param ingress.annotations Additional annotations for the Ingress resource. + ## @param ingress.annotations Additional annotations for the Ingress resource. annotations: {} # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true" - # @param ingress.hosts[0].host Host for the ingress resource - # @param ingress.hosts[0].paths[0].path The path to the bot endpoint - # @param ingress.hosts[0].paths[0].pathType Ingress path type + ## @param ingress.hosts[0].host Host for the ingress resource + ## @param ingress.hosts[0].paths[0].path The path to the bot endpoint + ## @param ingress.hosts[0].paths[0].pathType Ingress path type hosts: - host: sqbot.example.com paths: - path: / pathType: ImplementationSpecific - # @param ingress.tls The tls configuration for additional hostnames to be covered with configured ingress. - # see: https://kubernetes.io/docs/concepts/services-networking/ingress/#tls + ## @param ingress.tls The tls configuration for additional hostnames to be covered with configured ingress. + ## see: https://kubernetes.io/docs/concepts/services-networking/ingress/#tls tls: [] # - hosts: # - sqbot.example.com diff --git a/package-lock.json b/package-lock.json index decc27f..43e4f53 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,8 +6,8 @@ "": { "name": "gitea-sonarqube-pr-bot", "license": "MIT", - "dependencies": { - "readme-generator-for-helm": "^1.3.1" + "devDependencies": { + "readme-generator-for-helm": "https://github.com/bitnami-labs/readme-generator-for-helm/tarball/main" }, "engines": { "node": ">=12.21.0", @@ -17,12 +17,14 @@ "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true }, "node_modules/brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -32,6 +34,7 @@ "version": "7.2.0", "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "dev": true, "engines": { "node": ">= 10" } @@ -39,12 +42,14 @@ "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=" + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "dev": true }, "node_modules/dot-object": { "version": "2.1.4", "resolved": "https://registry.npmjs.org/dot-object/-/dot-object-2.1.4.tgz", "integrity": "sha512-7FXnyyCLFawNYJ+NhkqyP9Wd2yzuo+7n9pGiYpkmXCTYa8Ci2U0eUNDVg5OuO5Pm6aFXI2SWN8/N/w7SJWu1WA==", + "dev": true, "dependencies": { "commander": "^4.0.0", "glob": "^7.1.5" @@ -57,6 +62,7 @@ "version": "4.1.1", "resolved": "https://registry.npmjs.org/commander/-/commander-4.1.1.tgz", "integrity": "sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==", + "dev": true, "engines": { "node": ">= 6" } @@ -64,12 +70,14 @@ "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=" + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", + "dev": true }, "node_modules/glob": { - "version": "7.2.2", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.2.tgz", - "integrity": "sha512-NzDgHDiJwKYByLrL5lONmQFpK/2G78SMMfo+E9CuGlX4IkvfKDsiQSNPwAYxEy+e6p7ZQ3uslSLlwlJcqezBmQ==", + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "dev": true, "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", @@ -80,12 +88,16 @@ }, "engines": { "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", - "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "dev": true, "dependencies": { "once": "^1.3.0", "wrappy": "1" @@ -94,25 +106,33 @@ "node_modules/inherits": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true }, "node_modules/lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true }, "node_modules/markdown-table": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-2.0.0.tgz", "integrity": "sha512-Ezda85ToJUBhM6WGaG6veasyym+Tbs3cMAw/ZhOPqXiYsr0jgocBV3j3nx+4lk47plLlIqjwuTm/ywVI+zjJ/A==", + "dev": true, "dependencies": { "repeat-string": "^1.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" } }, "node_modules/minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, "dependencies": { "brace-expansion": "^1.1.7" }, @@ -123,7 +143,8 @@ "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", - "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, "dependencies": { "wrappy": "1" } @@ -131,15 +152,18 @@ "node_modules/path-is-absolute": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", - "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "dev": true, "engines": { "node": ">=0.10.0" } }, "node_modules/readme-generator-for-helm": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/readme-generator-for-helm/-/readme-generator-for-helm-1.3.1.tgz", - "integrity": "sha512-3esincvKfR32K+xdxbYXcDG2bhiPSJdmie4dDFJxEu2Y93Dm8xPoDn7ieppyEpSiTBKiIYBBfE6BwHW2HE/j+A==", + "version": "2.4.0", + "resolved": "https://github.com/bitnami-labs/readme-generator-for-helm/tarball/main", + "integrity": "sha512-W5ziOuId0M00YQRDlA5le3oEguWe8hoINhivOAgEF+AZkk2bDoNxuFUaJIxqAUEvZRA8qlTfUlu+w90EOFbTLw==", + "dev": true, + "license": "ISC", "dependencies": { "commander": "^7.1.0", "dot-object": "^2.1.4", @@ -154,7 +178,8 @@ "node_modules/repeat-string": { "version": "1.6.1", "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", - "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=", + "integrity": "sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w==", + "dev": true, "engines": { "node": ">=0.10" } @@ -162,12 +187,14 @@ "node_modules/wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=" + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "dev": true }, "node_modules/yaml": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.0.1.tgz", - "integrity": "sha512-1NpAYQ3wjzIlMs0mgdBmYzLkFgWBIWrzYVDYfrixhoFNNgJ444/jT2kUT2sicRbJES3oQYRZugjB6Ro8SjKeFg==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.1.1.tgz", + "integrity": "sha512-o96x3OPo8GjWeSLF+wOAbrPfhFOGY0W00GNaxCDv+9hkcDJEnev1yh8S7pgHF0ik6zc8sQLuL8hjHjJULZp8bw==", + "dev": true, "engines": { "node": ">= 14" } @@ -177,12 +204,14 @@ "balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true }, "brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, "requires": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -191,17 +220,20 @@ "commander": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", - "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==" + "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "dev": true }, "concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=" + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "dev": true }, "dot-object": { "version": "2.1.4", "resolved": "https://registry.npmjs.org/dot-object/-/dot-object-2.1.4.tgz", "integrity": "sha512-7FXnyyCLFawNYJ+NhkqyP9Wd2yzuo+7n9pGiYpkmXCTYa8Ci2U0eUNDVg5OuO5Pm6aFXI2SWN8/N/w7SJWu1WA==", + "dev": true, "requires": { "commander": "^4.0.0", "glob": "^7.1.5" @@ -210,19 +242,22 @@ "commander": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/commander/-/commander-4.1.1.tgz", - "integrity": "sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==" + "integrity": "sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==", + "dev": true } } }, "fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=" + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", + "dev": true }, "glob": { - "version": "7.2.2", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.2.tgz", - "integrity": "sha512-NzDgHDiJwKYByLrL5lONmQFpK/2G78SMMfo+E9CuGlX4IkvfKDsiQSNPwAYxEy+e6p7ZQ3uslSLlwlJcqezBmQ==", + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "dev": true, "requires": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", @@ -235,7 +270,8 @@ "inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", - "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "dev": true, "requires": { "once": "^1.3.0", "wrappy": "1" @@ -244,17 +280,20 @@ "inherits": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true }, "lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true }, "markdown-table": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-2.0.0.tgz", "integrity": "sha512-Ezda85ToJUBhM6WGaG6veasyym+Tbs3cMAw/ZhOPqXiYsr0jgocBV3j3nx+4lk47plLlIqjwuTm/ywVI+zjJ/A==", + "dev": true, "requires": { "repeat-string": "^1.0.0" } @@ -263,6 +302,7 @@ "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, "requires": { "brace-expansion": "^1.1.7" } @@ -270,7 +310,8 @@ "once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", - "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, "requires": { "wrappy": "1" } @@ -278,12 +319,13 @@ "path-is-absolute": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", - "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=" + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "dev": true }, "readme-generator-for-helm": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/readme-generator-for-helm/-/readme-generator-for-helm-1.3.1.tgz", - "integrity": "sha512-3esincvKfR32K+xdxbYXcDG2bhiPSJdmie4dDFJxEu2Y93Dm8xPoDn7ieppyEpSiTBKiIYBBfE6BwHW2HE/j+A==", + "version": "https://github.com/bitnami-labs/readme-generator-for-helm/tarball/main", + "integrity": "sha512-W5ziOuId0M00YQRDlA5le3oEguWe8hoINhivOAgEF+AZkk2bDoNxuFUaJIxqAUEvZRA8qlTfUlu+w90EOFbTLw==", + "dev": true, "requires": { "commander": "^7.1.0", "dot-object": "^2.1.4", @@ -295,17 +337,20 @@ "repeat-string": { "version": "1.6.1", "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", - "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=" + "integrity": "sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w==", + "dev": true }, "wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=" + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "dev": true }, "yaml": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.0.1.tgz", - "integrity": "sha512-1NpAYQ3wjzIlMs0mgdBmYzLkFgWBIWrzYVDYfrixhoFNNgJ444/jT2kUT2sicRbJES3oQYRZugjB6Ro8SjKeFg==" + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.1.1.tgz", + "integrity": "sha512-o96x3OPo8GjWeSLF+wOAbrPfhFOGY0W00GNaxCDv+9hkcDJEnev1yh8S7pgHF0ik6zc8sQLuL8hjHjJULZp8bw==", + "dev": true } } } diff --git a/package.json b/package.json index 3652b97..98aa01f 100644 --- a/package.json +++ b/package.json @@ -20,9 +20,9 @@ "npm": ">=8.0.0" }, "scripts": { - "helm-params": "cd node_modules/readme-generator-for-helm && node bin/index.js --config ./../../helm/readme-generator-config.json --readme ./../../helm/README.md --values ./../../helm/values.yaml" + "helm-params": "readme-generator --readme ./helm/README.md --values ./helm/values.yaml" }, - "dependencies": { - "readme-generator-for-helm": "^1.3.1" + "devDependencies": { + "readme-generator-for-helm": "https://github.com/bitnami-labs/readme-generator-for-helm/tarball/main" } }