Update changelog & PRE_COMMANDS documentation (#4002)

* Update changelog & PRE_COMMANDS documentation * [MegaLinter] Apply linters fixes --------- Co-authored-by: nvuillam <[email protected]>
oxsecurity · Sep 14, 2024 · ce15d11 · ce15d11
1 parent 02fcb08
commit ce15d11
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 2 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -45,6 +45,7 @@
         "SCSSLINT",
         "SOURCEBRANCHNAME",
         "St\u00e9phane",
+        "Suero",
         "Ywarn",
         "abefhkmnptuvx",
         "admiralawkbar",

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,8 +9,13 @@ 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
 
 - Core
+  - Allow to tag PRE_COMMANDS to run them before loading plugins, by @nvuillam in <https://github.com/oxsecurity/megalinter/pull/3944>
   - Replace usage of setup.py with a pyproject.toml package install, by @echoix in [#3893](https://github.com/oxsecurity/megalinter/pull/3893)
 
+- New linters
+  - New LUA linter: [**selene**](https://github.com/Kampfkarren/selene), by @AlejandroSuero in <https://github.com/oxsecurity/megalinter/pull/3978>
+  - New LUA formatter: [**stylua**](https://github.com/JohnnyMorganz/StyLua), by @AlejandroSuero in <https://github.com/oxsecurity/megalinter/pull/3985>
+
 - Media
 
 - Linters enhancements
@@ -20,11 +25,13 @@ Note: Can be used with `oxsecurity/megalinter@beta` in your GitHub Action mega-l
 - Reporters
 
 - Doc
+  - Update PRE_COMMANDS documentation to describe all properties
 
 - Flavors
 
 - CI
-  - Free space in release job to avoid no space left on device
+  - Free space in release job to avoid no space left on device, by @nvuillam in <https://github.com/oxsecurity/megalinter/pull/3914>
+  - Add `pytest-rerunfailures` to improve CI control jobs success, by @AlejandroSuero in <https://github.com/oxsecurity/megalinter/pull/3993>
 
 - mega-linter-runner
 

diff --git a/README.md b/README.md
@@ -1139,6 +1139,16 @@ PRE_COMMANDS:
     tag: before_plugins # Tag indicating that the command will be run before loading plugins
 ```
 
+| Property               | Description                                                                                                                              | Default value |
+|------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------|
+| **command**            | Command line to run                                                                                                                      | Mandatory     |
+| **cwd**                | Directory where to run the command (`workspace` or `root`)                                                                               | `workspace`   |
+| **secured_env**        | Apply filtering of secured env variables before calling the command (default true)<br/>Be careful if you disable it !                    | `true`        |
+| **continue_if_failed** | If set to `false`, stop MegaLinter process in case of command failure                                                                    | `true`        |
+| **venv**               | If set, runs the command into the related python venv                                                                                    | <!-- -->      |
+| **output_variables**   | ENV variables to get from output after running the commands, and store in MegaLinter ENV context, so they can be reused in next commands | `[]`          |
+| **tag**                | Tag defining at which commands entry point the command will be run   (available tags: `before_plugins`)                                  | <!-- -->      |
+
 <!-- config-precommands-section-end -->
 <!-- config-postcommands-section-start -->
 <!-- markdown-headers

diff --git a/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json b/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json
@@ -42,7 +42,7 @@
         },
         "secured_env": {
           "default": true,
-          "description": "Apply filter of secured env variables before calling the command (default true). Be careful if you disable it.",
+          "description": "Apply filtering of secured env variables before calling the command (default true). Be careful if you disable it.",
           "title": "Secured ENV variables",
           "type": "boolean"
         },