Skip to content
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

Issue #99: As a devops i would like to have automated linting for sh scripts #100

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 24 additions & 0 deletions .github/workflows/workflow-sh-check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Reusable Workflow for SH Script Conformance

## Overview

This workflow ensures that Shell scripts adhere to AI Lab's coding standards.
It's designed to automatically check the conformance of SH scripts to maintain
consistency and quality in the codebase.

## Usage

- **Purpose:** Automatically validate SH scripts against AI Lab's standards. It
triggers on workflow calls or push events, reviewing the scripts for
compliance.
- **Steps**
- Checkout Code: Fetches the latest code from the repository to be checked.
- Run ShellCheck: Executes ShellCheck, a tool for linting and static analysis
of SH scripts, to ensure they meet the predefined standards.

## SH Scripting Guidelines for Developers

- It's recommended to integrate
[ShellCheck](https://github.com/koalaman/shellcheck) in your local development
environment to catch issues early. ShellCheck provides detailed feedback for
improving your SH scripts, adhering to best practices and coding standards.
15 changes: 15 additions & 0 deletions .github/workflows/workflow-sh-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Check SH scripts conformance to AI Lab standards

on:

Check warning on line 4 in .github/workflows/workflow-sh-check.yml

View workflow job for this annotation

GitHub Actions / yaml-lint-check

4:1 [truthy] truthy value should be one of [false, true]
workflow_call:
push:

jobs:
sh-lint-check:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Run ShellCheck
uses: azohra/shell-linter@latest
Loading