buildkite-plugins / shellcheck-buildkite-plugin Goto Github PK

View Code? Open in Web Editor NEW

14.0 7.0 12.0 94 KB

🔍 Run shellcheck on your scripts

License: MIT License

Shell 100.00%

shellcheck buildkite buildkite-plugin

shellcheck-buildkite-plugin's Introduction

Shellcheck Buildkite Plugin

A Buildkite plugin that runs shellcheck against your shell scripts using the koalaman/shellcheck docker image.

Example

This will check all shellscripts with shellcheck.

steps:
  - plugins:
      - shellcheck#v1.3.0:
          files: scripts/*.sh

Configuration

Required

`files` (string or array of strings)

The files (or globs) to run shellcheck on.

Optional

`extended_glob` (boolean)

Enable using extended glob patterns, e.g. *.+(sh|bash)

Default: false

`recursive_glob` (boolean)

Enable using recursive globbing, e.g. **/*.sh

Note: requires at least Bash 4 on the Buildkite Agent

Default: false

`options` (string or array of strings)

Command line options to pass to shellcheck.

Default: "--color=always"

`version` (string)

Version of docker image to use.

Default: latest

License

MIT (see LICENSE)

shellcheck-buildkite-plugin's People

Contributors

Stargazers

Watchers

Forkers

durkode huonw theden stevehodgkiss thepratt nsuma8989 isabella232 robertkruk tonbara-stephanie lakhan-twilio sjames-au

shellcheck-buildkite-plugin's Issues

Plugin does not support docker image pinning

Looking for timely merge of #29, since I think some (all?) users of this plugin are experiencing breakage since the official docker image's latest build is broken. See koalaman/shellcheck#1751 for more details.

show building this plugin code supposed to work out the box?

Im getting errors in all my tests.
spellcheck, lint, tests etc.

Here's an example error from spellcheck:

Running global environment hook	0s
	Setting up elastic stack environment (v4.4.0)
	Downloading secrets from buildkiteec2stack-1-managedsecretsbucket-ojcfogfb902s
	Preparing plugins
	Preparing working directory
	Running global pre-command hook
	Running plugin shellcheck command hook
	$ /var/lib/buildkite-agent/plugins/github-com-buildkite-plugins-shellcheck-buildkite-plugin-v1-1-2/hooks/command
	No files found to shellcheck
	🚨 Error: The command exited with status 1
	Running global pre-exit hook
	$ /etc/buildkite-agent/hooks/pre-exit

Im new to Buildkite and is using this to test

Pass args to shellcheck

I would love to use this plugin, however what is blocking me is the inability to pass args to shellcheck, specifically rules to ignore and the -x option at the moment.

Would you welcome a PR for this? If so, are you happy with being able to pass through any options, or would you prefer to explicitly define what can be passed (such as rules to ignore)?

Support recursive glob

It was unexpected to discover that file patterns that are supported by the artefact plugin **/*.zip, are not supported by the shellcheck plugin, and also when using such patterns there is not output to indicate that recursive glob will not resolve.

I understand that the artefact plugin does its file pattern matching via Go's builtin glob matching, and the shellcheck plugin is relying on the agent's default shell (setting shopt -s globstar is not a guarantee to be available), but it would be great if somehow they behaved the same.

Unexpected behaviour

Given the directory structure of:

.
├── 1
│   └── secondlevel.sh
├── 2
│   └── anothersecondlevel.sh
├── 3
│   └── A
│       └── thirdlevel.sh
└── rootlevel.sh

steps:
  - plugins:
      - shellcheck#v1.1.2:
          files: **/*.sh

**/*.sh will only match secondlevel.sh, anothersecondlevel.sh (doesn't match root or any deeper levels)

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Update buildkite plugin docker-compose to v3.13.0

Detected dependencies

buildkite

.buildkite/pipeline.yml

docker-compose v3.9.0

plugin-linter v3.0.0

docker-compose

docker-compose.yml

Check this box to trigger a request for Renovate to run again on this repository

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Preset name not found within published preset config (monorepo:angularmaterial). Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.