From 202820162b46d4b6ee88eb02a2155b043f1f7c77 Mon Sep 17 00:00:00 2001
From: Javier Eguiluz <javier.eguiluz@gmail.com>
Date: Fri, 8 Jan 2021 10:25:50 +0100
Subject: [PATCH] [Yaml] Documented the github output format for the linter

---
 translation/lint.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/translation/lint.rst b/translation/lint.rst
index d9129a79108..14693f32826 100644
--- a/translation/lint.rst
+++ b/translation/lint.rst
@@ -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:
+
+.. 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
@@ -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