Skip to content

Commit

Permalink
docs: Simplify GitHub Actions example
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewimeson authored and adrienverge committed Aug 5, 2022
1 parent ae3158c commit 0130e15
Showing 1 changed file with 7 additions and 14 deletions.
21 changes: 7 additions & 14 deletions docs/integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,29 +22,22 @@ Integration with GitHub Actions
-------------------------------

yamllint auto-detects when it's running inside of `GitHub
Actions <https://github.com/features/actions>`_ and automatically uses the suited
output format to decorate code with linting errors. You can also force the
GitHub Actions output with ``yamllint --format github``.
Actions <https://github.com/features/actions>`_ and automatically uses the
suited output format to decorate code with linting errors. You can also force
the GitHub Actions output with ``yamllint --format github``.

An example workflow using GitHub Actions:
An minimal example workflow using GitHub Actions:

.. code:: yaml
---
name: yamllint test
on: push
on: push # yamllint disable-line rule:truthy
jobs:
test:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.8
- uses: actions/checkout@v3
- name: Install yamllint
run: pip install yamllint
Expand Down

0 comments on commit 0130e15

Please sign in to comment.