From 58a129c01e92d28d42324860daff45f915392d78 Mon Sep 17 00:00:00 2001 From: Kurt von Laven Date: Mon, 18 Oct 2021 16:40:04 -0700 Subject: [PATCH] Document -f argument to mega-linter-runner (#1895) -f is the short form of --flavor. --- CHANGELOG.md | 1 + mega-linter-runner/README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c31dc82548..3ec4df17c89 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,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 +- Document the `-f` argument to mega-linter-runner ([#1895](https://github.com/oxsecurity/megalinter/issues/1895)) - Fix a typo in documentation of bash-exec linter ([#1892](https://github.com/oxsecurity/megalinter/pull/1892)) - Add quotes to arm-ttk linter command ([#1879](https://github.com/oxsecurity/megalinter/issues/1879)) diff --git a/mega-linter-runner/README.md b/mega-linter-runner/README.md index cdc6000e427..bbc378d2a6b 100644 --- a/mega-linter-runner/README.md +++ b/mega-linter-runner/README.md @@ -97,7 +97,7 @@ The options are only related to mega-linter-runner. For MegaLinter options, plea | Option | Description | Default | |------------------------|--------------------------------------------------------------------------------------------------------------------|-------------------| | `-p`
`--path` | Directory containing the files to lint | current directory | -| `--flavor` | Set this parameter to use a [MegaLinter flavor](https://megalinter.github.io/flavors/) | `all` | +| `-f`
`--flavor` | Set this parameter to use a [MegaLinter flavor](https://megalinter.github.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 | |