Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[documentation] runner - doc fix for env list of values #2449

Merged
merged 5 commits into from
Mar 26, 2023
Merged

[documentation] runner - doc fix for env list of values #2449

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0cb124e
runner - doc fix for env list of values
DariuszPorowski Mar 9, 2023
f1088db
changelog
DariuszPorowski Mar 9, 2023
32cbf6a
runner README update in mega-linter-runner
DariuszPorowski Mar 10, 2023
22fc3dd
Merge branch 'main' into main
nvuillam Mar 11, 2023
9bc0887
Merge branch 'oxsecurity:main' into main
DariuszPorowski Mar 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,7 @@ megalinter-reports/
github_conf/

Pipfile

# .NET Core build folders
bin/
obj/
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
<!-- linter-versions-end -->

## [v6.20.1] - 2023-03-07
Expand Down
31 changes: 16 additions & 15 deletions docs/mega-linter-runner.md
View file
Open in desktop
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'
DariuszPorowski marked this conversation as resolved.
Show resolved Hide resolved
```

### 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