Skip to content

Enhance shellcheck and checkbashisms CI to automatically include all relevant files #38

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.

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

Open
arthurbdiniz opened this issue Dec 9, 2024 · 1 comment

Comments

@arthurbdiniz
Copy link
Contributor

Description

Currently, the shellcheck and checkbashisms step in .github/workflows/test.yml explicitly lists files to check:

- name: Run shellcheck
    run: shellcheck wcurl tests/*

- name: Run checkbashisms
    run: checkbashisms wcurl tests/*

This approach requires manual updates whenever files are added, renamed, or moved, which can lead to omissions in CI checks.

To improve maintainability, the workflow should dynamically include all relevant files without hardcoding their paths. There is related discussion on this topic in koalaman/shellcheck#143.

Tasks

  1. Research dynamic file inclusion methods compatible with shellcheck and checkbashisms.
  2. Update the workflow to automate file discovery.
  3. Test the updated workflow to ensure all relevant files are checked.
  4. Create a pull request with the enhanced configuration.

Outcome

This enhancement will reduce maintenance overhead and ensure comprehensive CI checks for shell scripts.

@arthurbdiniz arthurbdiniz changed the title Enhance shellcheck and checkbashisms CI to Automatically Include All Relevant Files Enhance shellcheck and checkbashisms CI to automatically include all relevant files Dec 9, 2024
@usha998
Copy link

usha998 commented Apr 30, 2025

Description

Currently, the shellcheck and checkbashisms step in .github/workflows/test.yml explicitly lists files to check:

  • name: Run shellcheck
    run: shellcheck wcurl tests/*

  • name: Run checkbashisms
    run: checkbashisms wcurl tests/*
    This approach requires manual updates whenever files are added, renamed, or moved, which can lead to omissions in CI checks.

To improve maintainability, the workflow should dynamically include all relevant files without hardcoding their paths. There is related discussion on this topic in koalaman/shellcheck#143.

Tasks

  1. Research dynamic file inclusion methods compatible with shellcheck and checkbashisms.
  2. Update the workflow to automate file discovery.
  3. Test the updated workflow to ensure all relevant files are checked.
  4. Create a pull request with the enhanced configuration.

Outcome

This enhancement will reduce maintenance overhead and ensure comprehensive CI checks for shell scripts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy