From c0d4c5a1064b993cd418609e196743b68d8cfbd0 Mon Sep 17 00:00:00 2001 From: Eli Flanagan Date: Tue, 7 May 2019 07:48:43 -0400 Subject: [PATCH] ensure docker invocation is ephemeral Also adjust the tag to use the `:stable` tag mentioned in the prior line. --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d426216..1da609f 100644 --- a/README.md +++ b/README.md @@ -114,14 +114,14 @@ Services and platforms with third party plugins: * [SonarQube](https://www.sonarqube.org/) through [sonar-shellcheck-plugin](https://github.com/emerald-squad/sonar-shellcheck-plugin) Most other services, including [GitLab](https://about.gitlab.com/), let you install -ShellCheck yourself, either through the system's package manager (see [Installing](#installing)), +ShellCheck yourself, either through the system's package manager (see [Installing](#installing)), or by downloading and unpacking a [binary release](#installing-the-shellcheck-binary). It's a good idea to manually install a specific ShellCheck version regardless. This avoids any surprise build breaks when a new version with new warnings is published. For customized filtering or reporting, ShellCheck can output simple JSON, CheckStyle compatible XML, -GCC compatible warnings as well as human readable text (with or without ANSI colors). See the +GCC compatible warnings as well as human readable text (with or without ANSI colors). See the [Integration](https://github.com/koalaman/shellcheck/wiki/Integration) wiki page for more documentation. ## Installing @@ -182,7 +182,7 @@ Or use OneClickInstall - https://software.opensuse.org/package/ShellCheck On Solus: eopkg install shellcheck - + On Windows (via [scoop](http://scoop.sh)): scoop install shellcheck @@ -195,7 +195,7 @@ From Docker Hub: ```sh docker pull koalaman/shellcheck:stable # Or :v0.4.7 for that version, or :latest for daily builds -docker run -v "$PWD:/mnt" koalaman/shellcheck myscript +docker run --rm -v "$PWD:/mnt" koalaman/shellcheck:stable myscript ``` or use `koalaman/shellcheck-alpine` if you want a larger Alpine Linux based image to extend. It works exactly like a regular Alpine image, but has shellcheck preinstalled. @@ -221,9 +221,9 @@ If you still want to do so in order to upgrade at your leisure or ensure the lat ## Installing the shellcheck binary -*Pre-requisite*: the program 'xz' needs to be installed on the system. -To install it on debian/ubuntu/linux mint, run `apt install xz-utils`. -To install it on Redhat/Fedora/CentOS, run `yum -y install xz`. +*Pre-requisite*: the program 'xz' needs to be installed on the system. +To install it on debian/ubuntu/linux mint, run `apt install xz-utils`. +To install it on Redhat/Fedora/CentOS, run `yum -y install xz`. ```bash export scversion="stable" # or "v0.4.7", or "latest" @@ -491,6 +491,6 @@ Copyright 2012-2018, Vidar 'koala_man' Holen and contributors. Happy ShellChecking! -## Other Resources +## Other Resources * The wiki has [long form descriptions](https://github.com/koalaman/shellcheck/wiki/Checks) for each warning, e.g. [SC2221](https://github.com/koalaman/shellcheck/wiki/SC2221). * ShellCheck does not attempt to enforce any kind of formatting or indenting style, so also check out [shfmt](https://github.com/mvdan/sh)!