Skip to content

[Yaml] Documented the github output format for the linter #14803

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 8, 2021
Merged

[Yaml] Documented the github output format for the linter #14803

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions translation/lint.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ The linter results can be exported to JSON using the ``--format`` option:
$ php bin/console lint:yaml translations/ --format=json
$ php bin/console lint:xliff translations/ --format=json

When running the YAML linter inside `GitHub Actions`_, the output is automatically
adapted to the format required by GitHub, but you can force that format too:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not say "required". It's a nicer output in GitHub, but not required (the normal stdout works fine).


.. code-block:: terminal

$ php bin/console lint:yaml translations/ --format=github

.. versionadded:: 5.3

The ``github`` output format was introduced in Symfony 5.3.

.. tip::

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

The ``yaml-lint`` binary was introduced in Symfony 5.1.

.. _`GitHub Actions`: https://docs.github.com/en/free-pro-team@latest/actions