{"id":19351715,"url":"https://github.com/operable/shellcheck-buildkite-plugin","last_synced_at":"2026-05-16T00:09:00.282Z","repository":{"id":90392722,"uuid":"79259056","full_name":"operable/shellcheck-buildkite-plugin","owner":"operable","description":"Shell script linter plugin for Buildkite","archived":false,"fork":false,"pushed_at":"2019-02-08T17:00:06.000Z","size":7,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-06T15:50:08.086Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/operable.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-17T18:39:39.000Z","updated_at":"2020-11-19T17:28:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"f4d8c005-bc54-47eb-9b70-e78c316fd945","html_url":"https://github.com/operable/shellcheck-buildkite-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fshellcheck-buildkite-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fshellcheck-buildkite-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fshellcheck-buildkite-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fshellcheck-buildkite-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/operable","download_url":"https://codeload.github.com/operable/shellcheck-buildkite-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240460603,"owners_count":19804929,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T04:37:02.276Z","updated_at":"2026-05-16T00:09:00.245Z","avatar_url":"https://github.com/operable.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# shellcheck-buildkite-plugin\nShell script linter plugin for Buildkite\n\n[![Build status](https://badge.buildkite.com/c00862681e75d87436590fe047fab7ef179142ebdacd3c40c0.svg?branch=master)](https://buildkite.com/operable/shellcheck-buildkite-plugin)\n\n**NOTE: Plugins only work with the as yet unlreleased 3.0 version of the Buildkite Agent!**\n\n**NOTE: This plugin is a work-in-progress. We use it internally at Operable to test our bundles. However, it may still blow up your systems; use at your own discretion!**\n\nThis plugin allows you to lint your shell scripts using [shellcheck](https://github.com/koalaman/shellcheck). It is implememnted in terms of the Docker image for `shellcheck`, so it must be run on a build agent that has access to `docker`.\n\n## Keys\n* `script`: specify the script (or scripts) to lint. Each file is linted individually.\n* `opts`: space-separated string of command-line options for `shellcheck`; corresponds to the `SHELLCHECK_OPTS` environment variable.\n\n   Useful options for the purposes of this plugin include `--exclude` (to exclude specific checks) and `--shell` (to specify a scripting dialect).\n\n   All options available can be seen by running `shellcheck` without any arguments, e.g.:\n\n```sh\ndocker run --rm -t koalaman/shellcheck\nNo files specified.\n\nUsage: shellcheck [OPTIONS...] FILES...\n  -e CODE1,CODE2..  --exclude=CODE1,CODE2..  exclude types of warnings\n  -f FORMAT         --format=FORMAT          output format\n  -C[WHEN]          --color[=WHEN]           Use color (auto, always, never)\n  -s SHELLNAME      --shell=SHELLNAME        Specify dialect (sh,bash,dash,ksh)\n  -x                --external-sources       Allow 'source' outside of FILES.\n  -V                --version                Print version information\n```\n\nCodes for the warnings can be found in the [shellcheck wiki](https://github.com/koalaman/shellcheck/wiki).\n\n## Usage\n\n```yaml\n- steps\n  - label: Simple linting\n    plugins:\n      operable/shellcheck:\n        script: my_script.sh\n\n  - label: Lint multiple scripts\n    plugins:\n      operable/shellcheck:\n        script:\n          - my_script.sh\n          - my_other_script.sh\n          - yet_another_script.sh\n\n  - label: Exclude some warnings\n    plugins:\n      operable/shellcheck:\n        script: my_script.sh\n        opts: --exclude=1000\n```\n\nAlso see this plugin's [pipeline configuration](.buildkite/pipeline.sh) for other examples.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foperable%2Fshellcheck-buildkite-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foperable%2Fshellcheck-buildkite-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foperable%2Fshellcheck-buildkite-plugin/lists"}