Skip to content

Commit 2028201

Browse files
committed
[Yaml] Documented the github output format for the linter
1 parent 3d022eb commit 2028201

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

translation/lint.rst

+13
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,17 @@ The linter results can be exported to JSON using the ``--format`` option:
3333
$ php bin/console lint:yaml translations/ --format=json
3434
$ php bin/console lint:xliff translations/ --format=json
3535
36+
When running the YAML linter inside `GitHub Actions`_, the output is automatically
37+
adapted to the format required by GitHub, but you can force that format too:
38+
39+
.. code-block:: terminal
40+
41+
$ php bin/console lint:yaml translations/ --format=github
42+
43+
.. versionadded:: 5.3
44+
45+
The ``github`` output format was introduced in Symfony 5.3.
46+
3647
.. tip::
3748

3849
The Yaml component provides a stand-alone ``yaml-lint`` binary allowing
@@ -45,3 +56,5 @@ The linter results can be exported to JSON using the ``--format`` option:
4556
.. versionadded:: 5.1
4657

4758
The ``yaml-lint`` binary was introduced in Symfony 5.1.
59+
60+
.. _`GitHub Actions`: https://docs.github.com/en/free-pro-team@latest/actions

0 commit comments

Comments
 (0)