https://github.com/circleci-public/github-super-linter-orb

A CircleCI Orb implementation of GitHub's SuperLinter. Run multiple linters in your CI pipeline at once.
https://github.com/circleci-public/github-super-linter-orb

actions ci circleci-orb linter

Last synced: about 1 year ago
JSON representation

A CircleCI Orb implementation of GitHub's SuperLinter. Run multiple linters in your CI pipeline at once.

• Host: GitHub
• URL: https://github.com/circleci-public/github-super-linter-orb
• Owner: CircleCI-Public
• License: mit
• Created: 2021-03-18T14:17:54.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-05-04T21:39:21.000Z (about 4 years ago)
• Last Synced: 2025-03-27T07:35:49.682Z (about 1 year ago)
• Topics: actions, ci, circleci-orb, linter
• Language: Shell
• Homepage: https://circleci.com/developer/orbs/orb/circleci/github-super-linter
• Size: 53.7 KB
• Stars: 2
• Watchers: 11
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GitHub Super-Linter for CircleCI (Orb)

[![CircleCI Build Status](https://circleci.com/gh/CircleCI-Public/GitHub-Super-Linter-Orb.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/CircleCI-Public/GitHub-Super-Linter-Orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/circleci/github-super-linter.svg)](https://circleci.com/orbs/registry/orb/circleci/github-super-linter) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/CircleCI-Public/GitHub-Super-Linter-Orb/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)

CircleCI Orbs allow users to package CI config into re-sharable components. This CircleCI Orb provides a `lint` job, powered by the GitHub Super-Linter Docker image.

## Usage:

Simply add the `github-super-linter/lint` job to your new or existing config.

```yaml

version: 2.1

orbs:

    github-super-linter: circleci/github-super-linter@1.0

workflows:

    lint-code:

        jobs:

        - github-super-linter/lint

```

## Resources

[CircleCI Orb Registry Page](https://circleci.com/orbs/registry/orb/circleci/GitHub-Super-Linter-Orb) - The official registry page of this orb for all versions, executors, commands, and jobs described.

[CircleCI Orb Docs](https://circleci.com/docs/2.0/orb-intro/#section=configuration) - Docs for using and creating CircleCI Orbs.

### How to Contribute

We welcome [issues](https://github.com/CircleCI-Public/GitHub-Super-Linter-Orb/issues) to and [pull requests](https://github.com/CircleCI-Public/GitHub-Super-Linter-Orb/pulls) against this repository!

For further questions/comments about this or other orbs, visit the Orb Category of [CircleCI Discuss](https://discuss.circleci.com/c/orbs).