From 4986818ee0bd2e8655c4c6410a123c14a1dd159d Mon Sep 17 00:00:00 2001 From: rose Date: Mon, 7 Jan 2019 14:04:34 -0500 Subject: [PATCH] add circleci info --- CircleCI.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/CircleCI.md b/CircleCI.md index c1b0730..fe04cde 100644 --- a/CircleCI.md +++ b/CircleCI.md @@ -1 +1,49 @@ -x \ No newline at end of file +Shellcheck can be run on CircleCI in a variety of ways: + +### Via [CircleCI Orbs](http://circleci.com/orbs) +CircleCI provides a `circleci/shellcheck` orb that can be used in any CircleCI workflow: + +https://circleci.com/orbs/registry/orb/circleci/shellcheck + +```yaml +version: 2.1 + +orbs: + shellcheck: circleci/shellcheck@1.0.0 + +workflows: + shellcheck: + jobs: + - shellcheck/check +``` + +### Manually +Simply copy and paste the [existing installation instructions](https://github.com/koalaman/shellcheck#installing) into a `run` step in your CircleCI job. + +For example: + +```yaml +version: 2.1 + +jobs: + build: + macos: + xcode: "9.0" + steps: + - checkout + - run: brew install shellcheck +``` + +Or, in a Linux-based image: + +```yaml +version: 2.1 + +jobs: + build: + machine: true + steps: + - checkout + - run: apt-get install shellcheck +``` + \ No newline at end of file