Skip to content

Commit 0130e15

Browse files
andrewimesonadrienverge
authored andcommitted
docs: Simplify GitHub Actions example
1 parent ae3158c commit 0130e15

File tree

1 file changed

+7
-14
lines changed

1 file changed

+7
-14
lines changed

docs/integration.rst

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,29 +22,22 @@ Integration with GitHub Actions
2222
-------------------------------
2323

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

29-
An example workflow using GitHub Actions:
29+
An minimal example workflow using GitHub Actions:
3030

3131
.. code:: yaml
3232
3333
---
34-
name: yamllint test
35-
36-
on: push
34+
on: push # yamllint disable-line rule:truthy
3735
3836
jobs:
39-
test:
37+
lint:
4038
runs-on: ubuntu-latest
4139
steps:
42-
- uses: actions/checkout@v2
43-
44-
- name: Set up Python
45-
uses: actions/setup-python@v2
46-
with:
47-
python-version: 3.8
40+
- uses: actions/checkout@v3
4841
4942
- name: Install yamllint
5043
run: pip install yamllint

0 commit comments

Comments
 (0)