oxidecomputer / oxidecomputer/omicron

consider running `shellcheck` as a part of pre-push CI

Open
#4,128 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cleanup development
Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

In the fullness of time, I'd like to get rid of many of the load-bearing bash scripts in this repo. It is likely we will always have some though. To prevent wasting time debugging these scripts, it might be nice to have a linter such as shellcheck run, similar to clippy.

#4127 cleans many of these up, but not all, so there will be some work there to make such a pre-push check function today.

Contributor guide

Open the contributing guide

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.

Research direction

Start by reviewing #4127 and inspecting the remaining bash scripts that would be checked. Then determine how shellcheck should run as part of pre-push CI. Done means the check runs successfully without being blocked by the scripts still present in the repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.