Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.3k
[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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: | ||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
| @@ -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 | ||