Skip to content

Commit

Permalink
Document that GitHub Actions already installs yamllint
Browse files Browse the repository at this point in the history
I was looking up instructions for how to install `yamllint` so that I could use it in our GitHub actions workflow when I happened to see mention that it's already installed in the base image.

So adding a quick note here.

I phrased the note generically because additional CI systems may (should!! 😄 ) start doing this, so we can easily add them to the list.
  • Loading branch information
jeffwidman committed May 1, 2024
1 parent 81e9f98 commit 8744b7a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Quickstart
Installing yamllint
-------------------

``yamllint`` is pre-installed on some systems (see the `GitHub Actions example <https://github.com/adrienverge/yamllint/pull/588#issuecomment-1679943422>`_).
Otherwise, here is how to install it on some popular OSes.

On Fedora / CentOS (note: `EPEL <https://docs.fedoraproject.org/en-US/epel/>`_ is
required on CentOS):

Expand Down

0 comments on commit 8744b7a

Please sign in to comment.