diff --git a/doc/user_guide/configuration/all-options.rst b/doc/user_guide/configuration/all-options.rst index 58f3a04b7c..7a9cec81a6 100644 --- a/doc/user_guide/configuration/all-options.rst +++ b/doc/user_guide/configuration/all-options.rst @@ -155,7 +155,7 @@ Standard Checkers --output-format """"""""""""""" -*Set the output format. Available formats are: text, parseable, colorized, json2 (improved json format), json (old json format) and msvs (visual studio). You can also give a reporter class, e.g. mypackage.mymodule.MyReporterClass.* +*Set the output format. Available formats are: 'text', 'parseable', 'colorized', 'json2' (improved json format), 'json' (old json format), msvs (visual studio) and 'github' (GitHub actions). You can also give a reporter class, e.g. mypackage.mymodule.MyReporterClass.* **Default:** ``text`` diff --git a/doc/user_guide/usage/output.rst b/doc/user_guide/usage/output.rst index 50a7fa76e4..1e962e8c84 100644 --- a/doc/user_guide/usage/output.rst +++ b/doc/user_guide/usage/output.rst @@ -8,8 +8,15 @@ Output by default is written to stdout. The simplest way to output to a file is with the ``--output=`` option. The default format for the output is raw text. You can change this by passing -pylint the ``--output-format=`` option. Possible values are: ``text``, ``json``, -``parseable``, ``colorized`` and ``msvs`` (for Visual Studio). +pylint the ``--output-format=`` option. Possible values are: + +* ``text`` +* ``parseable`` +* ``colorized`` +* ``json2``: improved json format +* ``json``: old json format +* ``msvs``: visual studio +* ``github``: `GitHub action messages `_ Multiple output formats can be used at the same time by passing a comma-separated list of formats to ``--output-format``. diff --git a/pylint/lint/base_options.py b/pylint/lint/base_options.py index 59a811d9c6..aa619f26e0 100644 --- a/pylint/lint/base_options.py +++ b/pylint/lint/base_options.py @@ -102,9 +102,9 @@ def _make_linter_options(linter: PyLinter) -> Options: "metavar": "", "short": "f", "group": "Reports", - "help": "Set the output format. Available formats are: text, " - "parseable, colorized, json2 (improved json format), json " - "(old json format) and msvs (visual studio). " + "help": "Set the output format. Available formats are: 'text', " + "'parseable', 'colorized', 'json2' (improved json format), 'json' " + "(old json format), msvs (visual studio) and 'github' (GitHub actions). " "You can also give a reporter class, e.g. mypackage.mymodule." "MyReporterClass.", "kwargs": {"linter": linter},