Concider folding lint workflow files into one

Open
#484 0 comments 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 4 days

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
git, github-actions
Domain
ci-cd

Research direction

The payload names the lint checks to merge: codespell, shellchecker, clang-format, and the sign-off and link trailer checks, but not the workflow file paths. Find the existing lint workflows in the repository's CI configuration first. The issue proposes one job with checkout as a fatal step and the other steps logging errors without stopping, and the job failing if any lint step fails. Ask the maintainers whether that failure policy is wanted before you start.

Written by the indexing model from the issue text.

Description

good first issue

Currently we have a number of lint stages and we're likely to get more. Namely:

  • codespell
  • shellchecker
  • clang-format
  • s-o-b trailer - see link
  • link trailer - people are occasionally misusing it

For some piece of mind, sanity and reduce(d) CI resources we can fold the lot roughly as:

  • single job - no need for parallelism, the git checkout is already the majority of the CI run
  • steps -> checkout, codespell, shellchecker....
  • checkout is fatal, other steps log an error and continue
  • the whole job fails, if any of the steps fail
Dominant language
C
Stars
116
Forks
70
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from kmod-project/kmod

All issues in kmod-project/kmod

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.