mirror of https://github.com/kuhyx/testsAndMisc.git synced 2026-11-10 20:27:02 +01:00

Krzysztof kuhy Rudnicki 4f2b0ccdf7 Dissolve linux_configuration/scripts/ and single_use/

Two levels of pure taxonomy carrying no information, and a 2-directory
cap leaves no room for them. Categories now sit directly under
linux_configuration/: features, fixes, utils, misc, fresh-install,
installers, diagnostics, gaming, boot_recovery, periodic_background, lib,
meta, tests. A script's own lib/ and tests/ are exempt from the cap, so
those stay put.

Depth violations 248 -> 139; roughly 40 of the remainder are inside
digital_wellbeing and hosts, deferred until the guard-lib repoint.

The moves are the easy half. What breaks is every path that counted
levels, and three classes of it had to be found by resolving paths rather
than reading diffs:

  - 52 relative `source` lines for lib/common.sh and lib/android.sh. The
    correct prefix differs per file: 40 were ../../ and 12 were ../../../,
    so a blanket replace would have fixed one set and broken the other.
  - REPO_ROOT in 7 fixes/lib/tests harnesses and setup_syncyomi_guard.sh,
    each walking up four levels from a directory now two levels shallower.
    This caused a real regression -- the fixes suite went red with
    "log_warn: command not found" -- caught by running it and comparing
    against the pre-move baseline worktree.
  - conftest.py's sys.path entries, which took the pytest gate down with
    14 collection errors, and the `# shellcheck source=` directives, which
    took shellcheck down with SC1091.

16 symlinks in $HOME broke, including the entire i3blocks bar. All
repointed, and cpu_monitor/memory/disk/time/volume were run to confirm
they emit real output rather than merely resolving.

Verified: 1798 tests pass at 100% coverage, 8 of 9 lib/tests suites pass
(the ninth needs the coverage jail, identically at baseline), pre-commit
is clean, and the two untracked secret configs are still ignored after
their gitignore paths changed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PJrqKERAo5QUeEHWS5Asgp

2026-08-23 18:53:30 +02:00

2.2 KiB

Raw Blame History

Branch Protection and Pre-Merge Checks

This repository uses GitHub Actions to ensure code quality before merging to main or master branches.

Required Checks

Shell Script Linting

The Shell Script Linting workflow automatically runs on:

Pull requests targeting main or master branches (including from forks)
Direct pushes to main or master branches

This workflow checks:

Shell script syntax with shellcheck
Code formatting with shfmt (2-space indentation, no tabs)
Optional checks: checkbashisms, syntax validation

Enabling Branch Protection

To make the shell linting check required before merging PRs, follow these steps:

Go to repository Settings → Branches
Click Add rule or edit existing rule for main/master
Configure the following settings:
- ✅ Require a pull request before merging
- ✅ Require status checks to pass before merging
  - Search for and select: Lint Shell Scripts
- ✅ Require branches to be up to date before merging (recommended)
- ✅ Do not allow bypassing the above settings (recommended)
Click Create or Save changes

Running Checks Locally

Before pushing changes, run the linting script locally to catch issues early:

bash meta/shell_check.sh

This will:

Install required linters on Arch Linux (if needed)
Check all shell scripts in the repository
Report any formatting or syntax issues

To auto-fix formatting issues:

# Install shfmt if not already installed
# On Arch: sudo pacman -S shfmt
# Or download from: https://github.com/mvdan/sh/releases

# Fix formatting in-place
find . -name "*.sh" -type f | xargs shfmt -w -i 2 -ci -sr -s

What Gets Checked

The workflow validates shell scripts with these extensions or shebangs:

*.sh, *.bash, *.zsh files
Executable files with shell shebangs (#!/bin/bash, #!/bin/sh, etc.)

Troubleshooting

If the check fails on your PR:

Review the workflow logs to see which files failed
Run bash meta/shell_check.sh locally to reproduce
Fix the issues (usually formatting with shfmt -w -i 2 -ci -sr -s)
Commit and push the fixes

The workflow will automatically re-run on new commits to the PR.

2.2 KiB Raw Blame History