Skip to content

Commit

Permalink
Build doc & force "pymdown-extensions==9.11"
Browse files Browse the repository at this point in the history
  • Loading branch information
@nvuillam
nvuillam committed May 17, 2023
1 parent 680c98c commit a3ddc04
Show file tree
Hide file tree
Showing 18 changed files with 509 additions and 36 deletions.
64 changes: 64 additions & 0 deletions .automation/generated/flavors-stats.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1483,6 +1483,10 @@
[
"2023-05-14T19:54:23",
2949683
],
[
"2023-05-17T23:06:02",
2956012
]
],
"ci_light": [
Expand Down Expand Up @@ -2969,6 +2973,10 @@
[
"2023-05-14T19:54:23",
63946
],
[
"2023-05-17T23:06:02",
64761
]
],
"cupcake": [
Expand Down Expand Up @@ -3435,6 +3443,10 @@
[
"2023-05-14T19:54:23",
10530
],
[
"2023-05-17T23:06:02",
10950
]
],
"dart": [
Expand Down Expand Up @@ -5831,6 +5843,10 @@
[
"2023-05-14T19:54:23",
147933
],
[
"2023-05-17T23:06:02",
149017
]
],
"dotnet": [
Expand Down Expand Up @@ -7317,6 +7333,10 @@
[
"2023-05-14T19:54:23",
383879
],
[
"2023-05-17T23:06:02",
385783
]
],
"go": [
Expand Down Expand Up @@ -8803,6 +8823,10 @@
[
"2023-05-14T19:54:23",
20467
],
[
"2023-05-17T23:06:02",
20680
]
],
"java": [
Expand Down Expand Up @@ -10289,6 +10313,10 @@
[
"2023-05-14T19:54:23",
118965
],
[
"2023-05-17T23:06:02",
119365
]
],
"javascript": [
Expand Down Expand Up @@ -11775,6 +11803,10 @@
[
"2023-05-14T19:54:23",
260734
],
[
"2023-05-17T23:06:02",
262757
]
],
"php": [
Expand Down Expand Up @@ -13261,6 +13293,10 @@
[
"2023-05-14T19:54:23",
49393
],
[
"2023-05-17T23:06:02",
49529
]
],
"python": [
Expand Down Expand Up @@ -14747,6 +14783,10 @@
[
"2023-05-14T19:54:23",
204309
],
[
"2023-05-17T23:06:02",
206008
]
],
"ruby": [
Expand Down Expand Up @@ -16229,6 +16269,10 @@
[
"2023-05-14T19:54:23",
3577
],
[
"2023-05-17T23:06:02",
3583
]
],
"rust": [
Expand Down Expand Up @@ -17711,6 +17755,10 @@
[
"2023-05-14T19:54:23",
5596
],
[
"2023-05-17T23:06:02",
5634
]
],
"salesforce": [
Expand Down Expand Up @@ -19197,6 +19245,10 @@
[
"2023-05-14T19:54:23",
19349
],
[
"2023-05-17T23:06:02",
19561
]
],
"scala": [
Expand Down Expand Up @@ -20681,6 +20733,10 @@
[
"2023-05-14T19:54:23",
9139
],
[
"2023-05-17T23:06:02",
9367
]
],
"swift": [
Expand Down Expand Up @@ -22163,6 +22219,10 @@
[
"2023-05-14T19:54:23",
3710
],
[
"2023-05-17T23:06:02",
3724
]
],
"terraform": [
Expand Down Expand Up @@ -23649,6 +23709,10 @@
[
"2023-05-14T19:54:23",
235814
],
[
"2023-05-17T23:06:02",
238459
]
]
}
2 changes: 2 additions & 0 deletions .automation/generated/linter-licenses.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"checkstyle": "LGPL-2.1",
"clippy": "Other",
"clj-kondo": "EPL-1.0",
"cljstyle": "EPL-1.0",
"coffeelint": "Other",
"cpplint": "Other",
"csharpier": "MIT",
Expand Down Expand Up @@ -41,6 +42,7 @@
"kics": "Apache-2.0",
"ktlint": "MIT",
"kubeconform": "Apache-2.0",
"kubescape": "Apache-2.0",
"kubeval": "Other",
"lintr": "Other",
"luacheck": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion .devcontainer/Dockerfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/
# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
COPY requirements.dev.txt /tmp/pip-tmp/
RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.dev.txt \
&& rm -rf /tmp/pip-tmp && pip3 install --no-cache-dir "mkdocs-material==9.1.12" mkdocs-glightbox==0.3.2
&& rm -rf /tmp/pip-tmp && pip3 install --no-cache-dir mkdocs-material pymdown-extensions==9.11 mkdocs-glightbox==0.3.2 pymdown-extensions==9.11

RUN npm install markdown-table-formatter -g

Expand Down
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ _If it doesn't work, just run the following script_

```shell
pip install -r requirements.dev.txt
pip install "mkdocs-material==9.1.12" "mkdocs-glightbox==0.3.2"
pip install mkdocs-material "mkdocs-glightbox==0.3.2" "pymdown-extensions==9.11"
npm install markdown-table-formatter -g
```

Expand Down Expand Up @@ -108,7 +108,7 @@ In order to be able to run locally a server that serves all the documentation an
Command to execute (only one time):

```bash
pip install --upgrade "markdown==3.3.7" mike mkdocs-material "mkdocs-glightbox==0.3.2" mdx_truly_sane_lists jsonschema json-schema-for-humans giturlparse webpreview github-dependents-info
pip install --upgrade "markdown==3.3.7" mike mkdocs-material "pymdown-extensions==9.11" "mkdocs-glightbox==0.3.2" mdx_truly_sane_lists jsonschema json-schema-for-humans giturlparse webpreview github-dependents-info
```

Command to run every time you want to bring up the server:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-deploy-docs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
- uses: actions/setup-python@v4.5.0
with:
python-version: 3.10.4
- run: pip install --upgrade markdown==3.3.7 mike "mkdocs-material==9.1.12" mkdocs-glightbox==0.3.2 mdx_truly_sane_lists json-schema-for-humans giturlparse webpreview
- run: pip install --upgrade markdown==3.3.7 mike mkdocs-material pymdown-extensions==9.11 mkdocs-glightbox==0.3.2 mdx_truly_sane_lists json-schema-for-humans giturlparse webpreview
- run: cd .automation && bash build_schemas_doc.sh && cd ..
# - run: mkdocs gh-deploy --force
- run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-RELEASE.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ jobs:
- uses: actions/setup-python@v4.5.0
with:
python-version: 3.x
- run: pip install --upgrade markdown==3.3.7 mike "mkdocs-material==9.1.12" mkdocs-glightbox==0.3.2 mdx_truly_sane_lists json-schema-for-humans giturlparse webpreview
- run: pip install --upgrade markdown==3.3.7 mike mkdocs-material pymdown-extensions==9.11 mkdocs-glightbox==0.3.2 mdx_truly_sane_lists json-schema-for-humans giturlparse webpreview
- run: cd .automation && bash build_schemas_doc.sh && cd ..
# - run: mkdocs gh-deploy --force
- run: |
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ MegaLinter is an **Open-Source** tool for **CI/CD workflows** that analyzes the

Supporting [**55** languages](#languages), [**24** formats](#formats), [**21** tooling formats](#tooling-formats) and **ready to use out of the box**, as a GitHub action or any CI system **highly configurable** and **free for all uses**.

[**Upgrade to MegaLinter v7 !**]<https://github.com/oxsecurity/megalinter/issues/2608>
[**Upgrade to MegaLinter v7 !**]https://github.com/oxsecurity/megalinter/issues/2608
<!-- welcome-phrase-end -->

<!-- online-doc-start -->
Expand Down
2 changes: 1 addition & 1 deletion docs/all_linters.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| [**chktex**](https://www.nongnu.org/chktex){target=_blank} | 1.7.6 | <!-- --> | <!-- --> | [LATEX](descriptors/latex_chktex.md) | :white_circle: | [Web Site](https://www.nongnu.org/chktex){target=_blank} |
| [**clippy**](https://github.com/rust-lang/rust-clippy){target=_blank} | 0.1.69 | [Other](licenses/clippy.md) | [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy){target=_blank} | [RUST](descriptors/rust_clippy.md) | :white_circle: | [Repository](https://github.com/rust-lang/rust-clippy){target=_blank} |
| [**clj-kondo**](https://github.com/borkdude/clj-kondo){target=_blank} | 2023.04.14 | [EPL-1.0](licenses/clj-kondo.md) | [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo){target=_blank} | [CLOJURE](descriptors/clojure_clj_kondo.md) | :heart: | [MegaLinter reference](https://github.com/borkdude/clj-kondo/blob/master/doc/ci-integration.md#github){target=_blank} |
| [**cljstyle**](https://github.com/greglook/cljstyle){target=_blank} | 0.15.0 | <!-- --> | [![GitHub stars](https://img.shields.io/github/stars/greglook/cljstyle?cacheSeconds=3600)](https://github.com/greglook/cljstyle){target=_blank} | [CLOJURE](descriptors/clojure_cljstyle.md) | :heart: | [MegaLinter reference](https://github.com/greglook/cljstyle/blob/main/doc/integrations.md){target=_blank} |
| [**cljstyle**](https://github.com/greglook/cljstyle){target=_blank} | 0.15.0 | [EPL-1.0](licenses/cljstyle.md) | [![GitHub stars](https://img.shields.io/github/stars/greglook/cljstyle?cacheSeconds=3600)](https://github.com/greglook/cljstyle){target=_blank} | [CLOJURE](descriptors/clojure_cljstyle.md) | :heart: | [MegaLinter reference](https://github.com/greglook/cljstyle/blob/main/doc/integrations.md){target=_blank} |
| [**coffeelint**](https://github.com/clutchski/coffeelint){target=_blank} | 5.2.11 | [Other](licenses/coffeelint.md) | [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint){target=_blank} | [COFFEE](descriptors/coffee_coffeelint.md) | :white_circle: | [Repository](https://github.com/clutchski/coffeelint){target=_blank} |
| [**cpplint**](https://github.com/cpplint/cpplint){target=_blank} | 1.6.1 | [Other](licenses/cpplint.md) | [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint){target=_blank} | [C](descriptors/c_cpplint.md)<br/> [CPP](descriptors/cpp_cpplint.md) | :white_circle: | [Repository](https://github.com/cpplint/cpplint){target=_blank} |
| [**csharpier**](https://github.com/belav/csharpier){target=_blank} | 0.24.2 | [MIT](licenses/csharpier.md) | [![GitHub stars](https://img.shields.io/github/stars/belav/csharpier?cacheSeconds=3600)](https://github.com/belav/csharpier){target=_blank} | [CSHARP](descriptors/csharp_csharpier.md) | :white_circle: | [Repository](https://github.com/belav/csharpier){target=_blank} |
Expand Down
2 changes: 1 addition & 1 deletion docs/descriptors/powershell_powershell.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ description: How to use powershell (configure, ignore files, ignore errors, help
| POWERSHELL_POWERSHELL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules |
| POWERSHELL_POWERSHELL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` |
| POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` |
| POWERSHELL_POWERSHELL_CLI_EXECUTABLE | Override CLI executable | `['pwsh']` |
| POWERSHELL_POWERSHELL_CLI_EXECUTABLE | Override CLI executable | `['powershell']` |

## IDE Integration

Expand Down
2 changes: 1 addition & 1 deletion docs/descriptors/powershell_powershell_formatter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ description: How to use powershell_formatter (configure, ignore files, ignore er
| POWERSHELL_POWERSHELL_FORMATTER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules |
| POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` |
| POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` |
| POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE | Override CLI executable | `['pwsh']` |
| POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE | Override CLI executable | `['powershell']` |

## IDE Integration

Expand Down
2 changes: 1 addition & 1 deletion docs/descriptors/xml_xmllint.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To apply file formatting you must set `XML_XMLLINT_CLI_LINT_MODE: file` and `XML
| Variable | Description | Default value |
|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| XML_XMLLINT_AUTOFORMAT | If set to `true`, it will reformat and reindent the output | `false` |
| XML_XMLLINT_INDENT | The number of indentation spaces when `XML_XMLLINT_AUTOFORMAT` is `true` | `` |
| XML_XMLLINT_INDENT | The number of indentation spaces when `XML_XMLLINT_AUTOFORMAT` is `true` | ` ` |
| XML_XMLLINT_ARGUMENTS | User custom arguments to add in linter CLI call<br/>Ex: `-s --foo "bar"` | |
| XML_XMLLINT_FILTER_REGEX_INCLUDE | Custom regex including filter<br/>Ex: `(src\|lib)` | Include every file |
| XML_XMLLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter<br/>Ex: `(test\|examples)` | Exclude no file |
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ MegaLinter is an **Open-Source** tool for **CI/CD workflows** that analyzes the

Supporting [**55** languages](supported-linters.md#languages), [**24** formats](supported-linters.md#formats), [**21** tooling formats](supported-linters.md#tooling-formats) and **ready to use out of the box**, as a GitHub action or any CI system **highly configurable** and **free for all uses**.

[**Upgrade to MegaLinter v7 !**]<https://github.com/oxsecurity/megalinter/issues/2608>
[**Upgrade to MegaLinter v7 !**]https://github.com/oxsecurity/megalinter/issues/2608
<!-- welcome-phrase-end -->

<!-- online-doc-start -->
Expand Down
Loading

0 comments on commit a3ddc04

Please sign in to comment.