From 8744b7a7e24574e55eaa3c06248b3e89db2c6c0e Mon Sep 17 00:00:00 2001 From: Jeff Widman Date: Tue, 15 Aug 2023 20:32:16 -0700 Subject: [PATCH] Document that GitHub Actions already installs `yamllint` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- docs/quickstart.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 9828dd62..1809dc7f 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -4,6 +4,9 @@ Quickstart Installing yamllint ------------------- +``yamllint`` is pre-installed on some systems (see the `GitHub Actions example `_). +Otherwise, here is how to install it on some popular OSes. + On Fedora / CentOS (note: `EPEL `_ is required on CentOS):