{"id":13495853,"url":"https://github.com/ludeeus/action-shellcheck","last_synced_at":"2025-05-15T00:06:31.240Z","repository":{"id":41888620,"uuid":"174679242","full_name":"ludeeus/action-shellcheck","owner":"ludeeus","description":"GitHub action for ShellCheck.","archived":false,"fork":false,"pushed_at":"2024-06-20T07:15:00.000Z","size":69,"stargazers_count":313,"open_issues_count":16,"forks_count":73,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-07T01:01:48.634Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ludeeus.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":"2019-03-09T10:24:54.000Z","updated_at":"2025-04-27T08:27:02.000Z","dependencies_parsed_at":"2024-01-08T07:59:22.230Z","dependency_job_id":"de32d53b-b68c-498b-be5a-b3beb64ff6ea","html_url":"https://github.com/ludeeus/action-shellcheck","commit_stats":{"total_commits":73,"total_committers":30,"mean_commits":2.433333333333333,"dds":0.6986301369863014,"last_synced_commit":"00b27aa7cb85167568cb48a3838b75f4265f2bca"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ludeeus%2Faction-shellcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ludeeus%2Faction-shellcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ludeeus%2Faction-shellcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ludeeus%2Faction-shellcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ludeeus","download_url":"https://codeload.github.com/ludeeus/action-shellcheck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254249199,"owners_count":22039029,"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-07-31T19:01:38.948Z","updated_at":"2025-05-15T00:06:31.179Z","avatar_url":"https://github.com/ludeeus.png","language":"Shell","funding_links":[],"categories":["Shell","others"],"sub_categories":[],"readme":"# ShellCheck\n\n_GitHub action for [ShellCheck](https://www.shellcheck.net/)._\n\n## Example\n\n```yaml\non:\n  push:\n    branches:\n      - master\n\nname: \"Trigger: Push action\"\npermissions: {}\n\njobs:\n  shellcheck:\n    name: Shellcheck\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - name: Run ShellCheck\n        uses: ludeeus/action-shellcheck@master\n```\n\n## ShellCheck options\n\nYou can pass any supported ShellCheck option or flag with the `SHELLCHECK_OPTS` env key in the job definition.\n\nSome examples include:\n\n- To disable specific checks (eg: `-e SC2059 -e SC2034 -e SC1090`)\n- To test against different shells (eg: `-s dash` or `-s ksh`)\n\nexample:\n\n```yaml\n    ...\n    - name: Run ShellCheck\n      uses: ludeeus/action-shellcheck@master\n      env:\n        SHELLCHECK_OPTS: -e SC2059 -e SC2034 -e SC1090\n```\n\n## Ignore paths and names\n\nYou can use the `ignore_paths` and `ignore_names` input to disable specific directories and files.\nThese are passed as environment variables, and should evaluate to a single space-separated string.\nIt may be convenient to use [`\u003e-`](https://yaml.org/spec/1.2.2/#65-line-folding) for readability if you have multiple selectors.\n\n```text\nsample structure:\nsample/directory/with/files/ignoreme/test.sh\nsample/directory/with/files/ignoremetoo/test.sh\nsample/directory/with/files/test.sh\nsample/directory/with/files/ignorable.sh\n```\n\nexample:\n\n```yaml\n    ...\n    - name: Run ShellCheck\n      uses: ludeeus/action-shellcheck@master\n      with:\n        ignore_paths: \u003e-\n          ignoreme\n          ignoremetoo\n        ignore_names: ignorable.sh\n```\n\nThis will skip `sample/directory/with/files/ignoreme/test.sh`, `sample/directory/with/files/ignoremetoo/test.sh` and `sample/directory/with/files/ignorable.sh`.\n\nYou can also ignore specific files using full paths or glob patterns with `ignore_paths`.\n\nexample:\n\n```yaml\n    ...\n    - name: Run ShellCheck\n      uses: ludeeus/action-shellcheck@master\n      with:\n        ignore_paths: ./sample/directory/with/files/ignorable.sh **/ignoreme/test.sh\n```\n\nThis will skip `sample/directory/with/files/ignorable.sh` and `sample/directory/with/files/ignoreme/test.sh`.\n\n## Minimum severity of errors to consider (error, warning, info, style)\n\nYou can use the `severity` input to not fail until specified severity is met, for example fail only if there are errors in scripts but ignore styling, info and warnings.\n\nexample:\n\n```yaml\n    ...\n    - name: Run ShellCheck\n      uses: ludeeus/action-shellcheck@master\n      with:\n        severity: error\n```\n\n## Run shellcheck with all paths in a single invocation\n\nIf you run into SC1090/SC1091 errors you may need to tell shellcheck to check\nall files at once:\n\n```yaml\n    ...\n    - name: Run ShellCheck\n      uses: ludeeus/action-shellcheck@master\n      with:\n        check_together: 'yes'\n```\n\nThis can turn into a problem if you have enough script files to overwhelm the\nmaximum argv length on your system.\n\n## Run shellcheck only in a single directory\n\nIf you have multiple directories with scripts, but only want to scan\none of them, you can use the following configuration:\n\n```yaml\n   ...\n   - name: Run ShellCheck\n     uses: ludeeus/action-shellcheck@master\n     with:\n       scandir: './scripts'\n```\n\n## Scan for additional files\n\nIf you need to scan for unusual files, you can use the `additional_files` key.\n\n```yaml\n   ...\n   - name: Run ShellCheck\n     uses: ludeeus/action-shellcheck@master\n     with:\n       additional_files: 'run finish'\n```\n\n## Change output format\n\nShellcheck can print output in these formats: `checkstyle`, `diff`, `gcc`, `json`, `json1`, `quiet`, `tty`. See some examples [here](https://github.com/koalaman/shellcheck/wiki/Integration#pick-the-output-format-that-makes-your-life-easier).\n\n- `tty` has multi-line log messages\n- `gcc` has single-line log messages\n\n```yaml\n   ...\n   - name: Run ShellCheck\n     uses: ludeeus/action-shellcheck@master\n     with:\n       format: tty\n```\n\n## Run a specific version of Shellcheck\n\nIf running the latest stable version of Shellcheck is not to your liking, you can specify a concrete version of Shellcheck to be used. When specifying a custom version, please use any of the released versions listed in the [Shellcheck repository](https://github.com/koalaman/shellcheck/tags).\n\n```yaml\n   ...\n   - name: Run ShellCheck\n     uses: ludeeus/action-shellcheck@master\n     with:\n       version: v0.9.0\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fludeeus%2Faction-shellcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fludeeus%2Faction-shellcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fludeeus%2Faction-shellcheck/lists"}