Skip to content

ci: Add shfmt formatting check for shell scripts #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roottool merged 5 commits into from
Jul 19, 2026
Merged

ci: Add shfmt formatting check for shell scripts #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c3416a8
ci: Add shfmt formatting check for shell scripts
roottool Jul 19, 2026
caca30b
ci: Add shfmt formatting check for shell scripts
roottool Jul 19, 2026
9fa4e47
ci: Add shellscripts filter
roottool Jul 19, 2026
288ffc4
ci: Change filter name
roottool Jul 19, 2026
7ddac2f
ci: Use paths-filter file list instead of find/grep for shell lint steps
roottool Jul 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ jobs:
outputs:
markdown: ${{ steps.filter.outputs.markdown }}
markdown_files: ${{ steps.filter.outputs.markdown_files }}
shellscript: ${{ steps.filter.outputs.shellscript }}
shellscript_files: ${{ steps.filter.outputs.shellscript_files }}
if: ${{ !github.event.pull_request.draft }}
steps:
- name: Assign yourself to this PR
Expand All @@ -43,6 +45,13 @@ jobs:
filters: |
markdown:
- '**/*.md'
shellscript:
- '**/*.sh'
- '**/*.zsh'
- 'dot_profile'
- 'dot_zprofile'
- 'dot_zsh*'
- '!examples/**'

lint:
name: Lint
Expand All @@ -54,9 +63,22 @@ jobs:
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
persist-credentials: false
- name: Setup shfmt
if: ${{ needs.setup.outputs.shellscript == 'true' }}
uses: mfinelli/setup-shfmt@a25fda4c1fe115aec0f85e04126610841bc3141d # v4.0.1
with:
shfmt-version: "3.13.1"
- parallel:
- name: Check formatting (shfmt)
if: ${{ needs.setup.outputs.shellscript == 'true' }}
env:
SHELLSCRIPT_FILES: ${{ needs.setup.outputs.shellscript_files }}
run: shfmt -d $SHELLSCRIPT_FILES
- name: ShellCheck
run: find . -type f \( -name 'dot_z*' -o -name '*.sh' -o -name '*.zsh' \) | grep -Ev 'examples/*' | xargs shellcheck
if: ${{ needs.setup.outputs.shellscript == 'true' }}
env:
SHELLSCRIPT_FILES: ${{ needs.setup.outputs.shellscript_files }}
run: shellcheck $SHELLSCRIPT_FILES
- name: Markdown lint
if: ${{ needs.setup.outputs.markdown == 'true' }}
uses: DavidAnson/markdownlint-cli2-action@8de2aa07cae85fd17c0b35642db70cf5495f1d25 # v24.0.0
Expand Down
1 change: 1 addition & 0 deletions Brewfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ brew "dysk"
brew "mkcert"
brew "pipx"
brew "sheldon"
brew "shfmt"
brew "starship"
brew "wget"
brew "zizmor"
Expand Down
4 changes: 2 additions & 2 deletions install-packages.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ sudo chmod a+r /etc/apt/keyrings/docker.asc
## Add the repository to Apt sources:
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] "https://download.docker.com/linux/$DISTRO_ID" \
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" |
sudo tee /etc/apt/sources.list.d/docker.list >/dev/null
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] "https://download.docker.com/linux/$DISTRO_ID" $(. /etc/os-release && echo "$VERSION_CODENAME") stable"
# Install Docker packages and Docker compose
sudo apt update
Expand Down
Loading