Skip to content

build: add shellcheck hook #4026

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

build: add shellcheck hook #4026

wants to merge 4 commits into from

Conversation

germa89
Copy link
Collaborator

@germa89 germa89 commented Jun 20, 2025

Description

As the title. To check bash scripts.

Issue linked

NA

Checklist

Summary by Sourcery

CI:

  • Configure ShellCheck hook at rev v0.10.0.1 in .pre-commit-config.yaml

@germa89 germa89 requested a review from a team as a code owner June 20, 2025 12:09
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

Copy link
Contributor

sourcery-ai bot commented Jun 20, 2025

Reviewer's Guide

Introduces shellcheck linting for bash scripts by adding a shellcheck hook to the pre-commit configuration.

Flow diagram for shellcheck integration in pre-commit workflow

flowchart TD
  A[Developer modifies bash script] --> B[Runs pre-commit]
  B --> C{Is shellcheck hook enabled?}
  C -- Yes --> D[Shellcheck lints bash scripts]
  D --> E{Linting passed?}
  E -- Yes --> F[Commit proceeds]
  E -- No --> G[Show shellcheck errors]
  G --> H[Fix errors and retry]
  C -- No --> F
Loading

File-Level Changes

Change Details Files
Integrate shellcheck into the pre-commit workflow
  • Add shellcheck-py repository entry
  • Set shellcheck-py revision to v0.10.0.1
  • Configure shellcheck hook under hooks
.pre-commit-config.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@germa89 germa89 self-assigned this Jun 20, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @germa89 - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions github-actions bot added the maintenance General maintenance of the repo (libraries, cicd, etc) label Jun 20, 2025
@github-actions github-actions bot added maintenance General maintenance of the repo (libraries, cicd, etc) and removed maintenance General maintenance of the repo (libraries, cicd, etc) labels Jun 20, 2025
@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc maintenance General maintenance of the repo (libraries, cicd, etc) and removed maintenance General maintenance of the repo (libraries, cicd, etc) labels Jun 20, 2025
Copy link

codecov bot commented Jun 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.11%. Comparing base (c30bfb8) to head (66b117e).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4026      +/-   ##
==========================================
- Coverage   89.12%   89.11%   -0.01%     
==========================================
  Files         187      187              
  Lines       14970    14970              
==========================================
- Hits        13342    13341       -1     
- Misses       1628     1629       +1     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Related with CICD, Github Actions, etc maintenance General maintenance of the repo (libraries, cicd, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants