Skip to content

Commit

Permalink
[documentation] runner - doc fix for env list of values (#2449)
Browse files Browse the repository at this point in the history 
* runner - doc fix for env list of values

* changelog

* runner README update in mega-linter-runner

---------

Co-authored-by: Nicolas Vuillamy <nicolas.vuillamy@gmail.com>
  • Loading branch information
@DariuszPorowski @nvuillam
DariuszPorowski and nvuillam authored Mar 26, 2023
1 parent ae9697a commit 65d3ca4
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 31 deletions.
7 changes: 6 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,9 @@ github_conf/

Pipfile

run_local_linter.sh
# .NET Core build folders
bin/
obj/

run_local_linter.sh

3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Note: Can be used with `oxsecurity/megalinter@beta` in your GitHub Action mega-l

- Core
- Run CI linter jobs only on Pull requests to avoid doubling jobs

- Documentation
- mega-linter-runner: doc fix for env list of values, see [#2448](https://github.com/oxsecurity/megalinter/issues/2448)

- Linter versions upgrades
- [ansible-lint](https://ansible-lint.readthedocs.io/) from 6.14.1 to **6.14.2** on 2023-03-11
Expand Down
31 changes: 16 additions & 15 deletions docs/mega-linter-runner.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

<!-- readme-header-start -->

<!-- readme-header-end -->
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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` <br/> `--path` | Directory containing the files to lint | current directory |
| `-f` <br/> `--flavor` | Set this parameter to use a [MegaLinter flavor](https://megalinter.io/flavors/) | `all` |
| `-d` <br/> `--image` | You can override the used docker image, including if it is on another docker registry | <!-- --> |
| `-e` <br/> `--env` | Environment variables for MegaLinter, following format **'ENV_VAR_NAME=VALUE'** <br/>Warning: Quotes are mandatory | <!-- --> |
| `--fix` | Automatically apply formatting and fixes in your files | <!-- --> |
| `-r` <br/> `--release` | Allows to override MegaLinter version used | `v5` |
| `-h` <br/> `--help` | Show mega-linter-runner help | <!-- --> |
| `-v` <br/> `--version` | Show mega-linter-runner version | <!-- --> |
| `-i` <br/> `--install` | Generate MegaLinter configuration files | <!-- --> |
| `--container-name` | Specify MegaLinter container name | <!-- --> |
| `--remove-container` | Remove MegaLinter Docker container when done | <!-- --> |
| Option | Description | Default |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| `-p` <br/> `--path` | Directory containing the files to lint | current directory |
| `-f` <br/> `--flavor` | Set this parameter to use a [MegaLinter flavor](https://megalinter.io/flavors/) | `all` |
| `-d` <br/> `--image` | You can override the used docker image, including if it is on another docker registry | <!-- --> |
| `-e` <br/> `--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<br/>Warning: Quotes are mandatory | <!-- --> |
| `--fix` | Automatically apply formatting and fixes in your files | <!-- --> |
| `-r` <br/> `--release` | Allows to override MegaLinter version used | `v5` |
| `-h` <br/> `--help` | Show mega-linter-runner help | <!-- --> |
| `-v` <br/> `--version` | Show mega-linter-runner version | <!-- --> |
| `-i` <br/> `--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_

Expand All @@ -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
Expand Down
30 changes: 15 additions & 15 deletions mega-linter-runner/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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` <br/> `--path` | Directory containing the files to lint | current directory |
| `-f` <br/> `--flavor` | Set this parameter to use a [MegaLinter flavor](https://megalinter.io/flavors/) | `all` |
| `-d` <br/> `--image` | You can override the used docker image, including if it is on another docker registry | <!-- --> |
| `-e` <br/> `--env` | Environment variables for MegaLinter, following format **'ENV_VAR_NAME=VALUE'** <br/>Warning: Quotes are mandatory | <!-- --> |
| `--fix` | Automatically apply formatting and fixes in your files | <!-- --> |
| `-r` <br/> `--release` | Allows to override MegaLinter version used | `v5` |
| `-h` <br/> `--help` | Show mega-linter-runner help | <!-- --> |
| `-v` <br/> `--version` | Show mega-linter-runner version | <!-- --> |
| `-i` <br/> `--install` | Generate MegaLinter configuration files | <!-- --> |
| `--container-name` | Specify MegaLinter container name | <!-- --> |
| `--remove-container` | Remove MegaLinter Docker container when done | <!-- --> |
| Option | Description | Default |
|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
| `-p` <br/> `--path` | Directory containing the files to lint | current directory |
| `-f` <br/> `--flavor` | Set this parameter to use a [MegaLinter flavor](https://megalinter.io/flavors/) | `all` |
| `-d` <br/> `--image` | You can override the used docker image, including if it is on another docker registry | <!-- --> |
| `-e` <br/> `--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<br/>Warning: Quotes are mandatory | <!-- --> |
| `--fix` | Automatically apply formatting and fixes in your files | <!-- --> |
| `-r` <br/> `--release` | Allows to override MegaLinter version used | `v5` |
| `-h` <br/> `--help` | Show mega-linter-runner help | <!-- --> |
| `-v` <br/> `--version` | Show mega-linter-runner version | <!-- --> |
| `-i` <br/> `--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_

Expand All @@ -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
Expand Down

0 comments on commit 65d3ca4

Please sign in to comment.