From 0130e15c8c7237d48b6133a03612b9b4e539c083 Mon Sep 17 00:00:00 2001 From: Andrew Imeson Date: Tue, 14 Jun 2022 21:53:05 -0400 Subject: [PATCH] docs: Simplify GitHub Actions example --- docs/integration.rst | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/docs/integration.rst b/docs/integration.rst index 7b349ff..ede2aa0 100644 --- a/docs/integration.rst +++ b/docs/integration.rst @@ -22,29 +22,22 @@ Integration with GitHub Actions ------------------------------- yamllint auto-detects when it's running inside of `GitHub -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 `_ 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