From 0cb124e9b9802cd6ad7917cc1e8fd424c2d60a5d Mon Sep 17 00:00:00 2001 From: Dariusz Porowski <3431813+DariuszPorowski@users.noreply.github.com> Date: Thu, 9 Mar 2023 08:33:49 -0800 Subject: [PATCH 1/3] runner - doc fix for env list of values --- .gitignore | 4 ++++ docs/mega-linter-runner.md | 31 ++++++++++++++++--------------- 2 files changed, 20 insertions(+), 15 deletions(-) diff --git a/.gitignore b/.gitignore index 3d5e18ea75f..ea109d1a45d 100644 --- a/.gitignore +++ b/.gitignore @@ -110,3 +110,7 @@ megalinter-reports/ github_conf/ Pipfile + +# .NET Core build folders +bin/ +obj/ diff --git a/docs/mega-linter-runner.md b/docs/mega-linter-runner.md index 9c740066ae1..4215287681f 100644 --- a/docs/mega-linter-runner.md +++ b/docs/mega-linter-runner.md @@ -11,6 +11,7 @@ [![Downloads/week](https://img.shields.io/npm/dw/mega-linter-runner.svg)](https://npmjs.org/package/mega-linter-runner) [![Downloads/total](https://img.shields.io/npm/dt/mega-linter-runner.svg)](https://npmjs.org/package/mega-linter-runner) [![GitHub stars](https://img.shields.io/github/stars/oxsecurity/megalinter?maxAge=2592000)](https://GitHub.com/oxsecurity/megalinter/stargazers/) + @@ -44,7 +45,7 @@ You can run mega-linter-runner without installation by using `npx` Example: ```shell -npx mega-linter-runner -r beta -e 'ENABLE=MARKDOWN,YAML' -e 'SHOW_ELAPSED_TIME=true' +npx mega-linter-runner -r beta -e "'ENABLE=MARKDOWN,YAML'" -e 'SHOW_ELAPSED_TIME=true' ``` ### Pre-commit hook @@ -76,19 +77,19 @@ mega-linter-runner [OPTIONS] [FILES] The options are only related to mega-linter-runner. For MegaLinter options, please use a `.mega-linter.yml` [configuration file](#configuration) -| Option | Description | Default | -|------------------------|--------------------------------------------------------------------------------------------------------------------|-------------------| -| `-p`
`--path` | Directory containing the files to lint | current directory | -| `-f`
`--flavor` | Set this parameter to use a [MegaLinter flavor](https://megalinter.io/flavors/) | `all` | -| `-d`
`--image` | You can override the used docker image, including if it is on another docker registry | | -| `-e`
`--env` | Environment variables for MegaLinter, following format **'ENV_VAR_NAME=VALUE'**
Warning: Quotes are mandatory | | -| `--fix` | Automatically apply formatting and fixes in your files | | -| `-r`
`--release` | Allows to override MegaLinter version used | `v5` | -| `-h`
`--help` | Show mega-linter-runner help | | -| `-v`
`--version` | Show mega-linter-runner version | | -| `-i`
`--install` | Generate MegaLinter configuration files | | -| `--container-name` | Specify MegaLinter container name | | -| `--remove-container` | Remove MegaLinter Docker container when done | | +| Option | Description | Default | +| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| `-p`
`--path` | Directory containing the files to lint | current directory | +| `-f`
`--flavor` | Set this parameter to use a [MegaLinter flavor](https://megalinter.io/flavors/) | `all` | +| `-d`
`--image` | You can override the used docker image, including if it is on another docker registry | | +| `-e`
`--env` | Environment variables for MegaLinter, following format **'ENV_VAR_NAME=VALUE'** for a single value or **"'ENV_VAR_NAME=VALUE1,VALUE2'"** for a list of values
Warning: Quotes are mandatory | | +| `--fix` | Automatically apply formatting and fixes in your files | | +| `-r`
`--release` | Allows to override MegaLinter version used | `v5` | +| `-h`
`--help` | Show mega-linter-runner help | | +| `-v`
`--version` | Show mega-linter-runner version | | +| `-i`
`--install` | Generate MegaLinter configuration files | | +| `--container-name` | Specify MegaLinter container name | | +| `--remove-container` | Remove MegaLinter Docker container when done | | _You can also use `npx mega-linter-runner` if you do not want to install the package_ @@ -103,7 +104,7 @@ mega-linter-runner -p myFolder --fix ``` ```shell -mega-linter-runner -r beta -e 'ENABLE=MARKDOWN,YAML' -e 'SHOW_ELAPSED_TIME=true' +mega-linter-runner -r beta -e "'ENABLE=MARKDOWN,YAML'" -e 'SHOW_ELAPSED_TIME=true' ``` ```shell From f1088db05b9c819d965f50a29a7fbbe851d75449 Mon Sep 17 00:00:00 2001 From: Dariusz Porowski <3431813+DariuszPorowski@users.noreply.github.com> Date: Thu, 9 Mar 2023 08:39:51 -0800 Subject: [PATCH 2/3] changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a3db26a93e6..cca74ca4631 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), Note: Can be used with `oxsecurity/megalinter@beta` in your GitHub Action mega-linter.yml file, or with `oxsecurity/megalinter:beta` docker image - Linter versions upgrades +- runner - doc fix for env list of values, see [#2448](https://github.com/oxsecurity/megalinter/issues/2448) ## [v6.20.1] - 2023-03-07 From 32cbf6a5100222d8e9d35b937da3e45e80ba2b55 Mon Sep 17 00:00:00 2001 From: Dariusz Porowski <3431813+DariuszPorowski@users.noreply.github.com> Date: Fri, 10 Mar 2023 11:28:10 -0800 Subject: [PATCH 3/3] runner README update in mega-linter-runner --- mega-linter-runner/README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/mega-linter-runner/README.md b/mega-linter-runner/README.md index 311861b47c1..bb60f4f814d 100644 --- a/mega-linter-runner/README.md +++ b/mega-linter-runner/README.md @@ -62,7 +62,7 @@ You can run mega-linter-runner without installation by using `npx` Example: ```shell -npx mega-linter-runner -r beta -e 'ENABLE=MARKDOWN,YAML' -e 'SHOW_ELAPSED_TIME=true' +npx mega-linter-runner -r beta -e "'ENABLE=MARKDOWN,YAML'" -e 'SHOW_ELAPSED_TIME=true' ``` ### Pre-commit hook @@ -94,19 +94,19 @@ mega-linter-runner [OPTIONS] [FILES] The options are only related to mega-linter-runner. For MegaLinter options, please use a `.mega-linter.yml` [configuration file](#configuration) -| Option | Description | Default | -|------------------------|--------------------------------------------------------------------------------------------------------------------|-------------------| -| `-p`
`--path` | Directory containing the files to lint | current directory | -| `-f`
`--flavor` | Set this parameter to use a [MegaLinter flavor](https://megalinter.io/flavors/) | `all` | -| `-d`
`--image` | You can override the used docker image, including if it is on another docker registry | | -| `-e`
`--env` | Environment variables for MegaLinter, following format **'ENV_VAR_NAME=VALUE'**
Warning: Quotes are mandatory | | -| `--fix` | Automatically apply formatting and fixes in your files | | -| `-r`
`--release` | Allows to override MegaLinter version used | `v5` | -| `-h`
`--help` | Show mega-linter-runner help | | -| `-v`
`--version` | Show mega-linter-runner version | | -| `-i`
`--install` | Generate MegaLinter configuration files | | -| `--container-name` | Specify MegaLinter container name | | -| `--remove-container` | Remove MegaLinter Docker container when done | | +| Option | Description | Default | +|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| `-p`
`--path` | Directory containing the files to lint | current directory | +| `-f`
`--flavor` | Set this parameter to use a [MegaLinter flavor](https://megalinter.io/flavors/) | `all` | +| `-d`
`--image` | You can override the used docker image, including if it is on another docker registry | | +| `-e`
`--env` | Environment variables for MegaLinter, following format **'ENV_VAR_NAME=VALUE'** for a single value or **"'ENV_VAR_NAME=VALUE1,VALUE2'"** for a list of values
Warning: Quotes are mandatory | | +| `--fix` | Automatically apply formatting and fixes in your files | | +| `-r`
`--release` | Allows to override MegaLinter version used | `v5` | +| `-h`
`--help` | Show mega-linter-runner help | | +| `-v`
`--version` | Show mega-linter-runner version | | +| `-i`
`--install` | Generate MegaLinter configuration files | | +| `--container-name` | Specify MegaLinter container name | | +| `--remove-container` | Remove MegaLinter Docker container when done | | _You can also use `npx mega-linter-runner` if you do not want to install the package_ @@ -121,7 +121,7 @@ mega-linter-runner -p myFolder --fix ``` ```shell -mega-linter-runner -r beta -e 'ENABLE=MARKDOWN,YAML' -e 'SHOW_ELAPSED_TIME=true' +mega-linter-runner -r beta -e "'ENABLE=MARKDOWN,YAML'" -e 'SHOW_ELAPSED_TIME=true' ``` ```shell