github / github/github-ospo

Utilize github.com/super-linter/super-linter for local linting

Open
#97 1 comment 1 reaction 0 assignees View on GitHub
enhancement ospo-actions
Dominant language
No language data
Stars
749
Forks
72
PR merge metrics
No merged PRs in 30d

Description

### Is your feature request related to a problem?

Currently we use a `make lint` target to run linting locally in each of our OSPO GitHub Actions ([example](https://github.com/github/cleanowners/blob/5a3a1046af4871a9c6d48f8e9435c49e1abf15f4/Makefile#L9-L18)). This "works" but does not cover the larger list of linters that super-linter runs against our code in our linting workflow on each OSPO GitHub Action ([example](https://github.com/github/cleanowners/blob/main/.github/workflows/super-linter.yaml)).

The issue is that super-linter does not work well on arm64 architecture (Apple M1, for example). There is an [open PR trying to work through this](https://github.com/super-linter/super-linter/pull/5320).

### Related OSPO Tool

automatic-contrib-prs GitHub Action, cleanowners GitHub Action, contributors GitHub Action, evergreen GitHub Action, issues-metrics GitHub Action, stale-repos GitHub Action

### Describe the solution you'd like

We spin up a super-linter container and run linting against the local code

### Describe alternatives you've considered

Current: Makefile calling individual tools to try to match the large lister of linters built into super-linter and run in our linting workflow on each OSPO GitHub Action

### Additional context

We have people subscribed to the super-linter PR and will try this out as soon as that is merged.

Contributor guide

Open the contributing guide

Research direction

Compare the Makefile's current lint target with .github/workflows/super-linter.yaml and review the linked super-linter arm64 pull request first. Done means local linting runs through a super-linter container and covers the linters used by the workflow without relying on the current individual-tool list.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, github-actions
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.