mirror of
https://github.com/ivuorinen/actions.git
synced 2026-03-06 15:56:02 +00:00
feat: fixes, tweaks, new actions, linting (#186)
* feat: fixes, tweaks, new actions, linting * fix: improve docker publish loops and dotnet parsing (#193) * fix: harden action scripts and version checks (#191) * refactor: major repository restructuring and security enhancements Add comprehensive development infrastructure: - Add Makefile with automated documentation generation, formatting, and linting tasks - Add TODO.md tracking self-containment progress and repository improvements - Add .nvmrc for consistent Node.js version management - Create python-version-detect-v2 action for enhanced Python detection Enhance all GitHub Actions with standardized patterns: - Add consistent token handling across 27 actions using standardized input patterns - Implement bash error handling (set -euo pipefail) in all shell steps - Add comprehensive input validation for path traversal and command injection protection - Standardize checkout token authentication to prevent rate limiting - Remove relative action dependencies to ensure external usability Rewrite security workflow for PR-focused analysis: - Transform security-suite.yml to PR-only security analysis workflow - Remove scheduled runs, repository issue management, and Slack notifications - Implement smart comment generation showing only sections with content - Add GitHub Actions permission diff analysis and new action detection - Integrate OWASP, Semgrep, and TruffleHog for comprehensive PR security scanning Improve version detection and dependency management: - Simplify version detection actions to use inline logic instead of shared utilities - Fix Makefile version detection fallback to properly return 'main' when version not found - Update all external action references to use SHA-pinned versions - Remove deprecated run.sh in favor of Makefile automation Update documentation and project standards: - Enhance CLAUDE.md with self-containment requirements and linting standards - Update README.md with improved action descriptions and usage examples - Standardize code formatting with updated .editorconfig and .prettierrc.yml - Improve GitHub templates for issues and security reporting This refactoring ensures all 40 actions are fully self-contained and can be used independently when referenced as ivuorinen/actions/action-name@main, addressing the critical requirement for external usability while maintaining comprehensive security analysis and development automation. * feat: add automated action catalog generation system - Create generate_listing.cjs script for comprehensive action catalog - Add package.json with development tooling and npm scripts - Implement automated README.md catalog section with --update flag - Generate markdown reference-style links for all 40 actions - Add categorized tables with features, language support matrices - Replace static reference links with auto-generated dynamic links - Enable complete automation of action documentation maintenance * feat: enhance actions with improved documentation and functionality - Add comprehensive README files for 12 actions with usage examples - Implement new utility actions (go-version-detect, dotnet-version-detect) - Enhance node-setup with extensive configuration options - Improve error handling and validation across all actions - Update package.json scripts for better development workflow - Expand TODO.md with detailed roadmap and improvement plans - Standardize action structure with consistent inputs/outputs * feat: add comprehensive output handling across all actions - Add standardized outputs to 15 actions that previously had none - Implement consistent snake_case naming convention for all outputs - Add build status and test results outputs to build actions - Add files changed and status outputs to lint/fix actions - Add test execution metrics to php-tests action - Add stale/closed counts to stale action - Add release URLs and IDs to github-release action - Update documentation with output specifications - Mark comprehensive output handling task as complete in TODO.md * feat: implement shared cache strategy across all actions - Add caching to 10 actions that previously had none (Node.js, .NET, Python, Go) - Standardize 4 existing actions to use common-cache instead of direct actions/cache - Implement consistent cache-hit optimization to skip installations when cache available - Add language-specific cache configurations with appropriate key files - Create unified caching approach using ivuorinen/actions/common-cache@main - Fix YAML syntax error in php-composer action paths parameter - Update TODO.md to mark shared cache strategy as complete * feat: implement comprehensive retry logic for network operations - Create new common-retry action for standardized retry patterns with configurable strategies - Add retry logic to 9 actions missing network retry capabilities - Implement exponential backoff, custom timeouts, and flexible error handling - Add max-retries input parameter to all network-dependent actions (Node.js, .NET, Python, Go) - Standardize existing retry implementations to use common-retry utility - Update action catalog to include new common-retry action (41 total actions) - Update documentation with retry configuration examples and parameters - Mark retry logic implementation as complete in TODO.md roadmap * feat: enhance Node.js support with Corepack and Bun - Add Corepack support for automatic package manager version management - Add Bun package manager support across all Node.js actions - Improve Yarn Berry/PnP support with .yarnrc.yml detection - Add Node.js feature detection (ESM, TypeScript, frameworks) - Update package manager detection priority and lockfile support - Enhance caching with package-manager-specific keys - Update eslint, prettier, and biome actions for multi-package-manager support * fix: resolve critical runtime issues across multiple actions - Fix token validation by removing ineffective literal string comparisons - Add missing @microsoft/eslint-formatter-sarif dependency for SARIF output - Fix Bash variable syntax errors in username and changelog length checks - Update Dockerfile version regex to handle tags with suffixes (e.g., -alpine) - Simplify version selection logic with single grep command - Fix command execution in retry action with proper bash -c wrapper - Correct step output references using .outcome instead of .outputs.outcome - Add missing step IDs for version detection actions - Include go.mod in cache key files for accurate invalidation - Require minor version in all version regex patterns - Improve Bun installation security by verifying script before execution - Replace bc with sort -V for portable PHP version comparison - Remove non-existent pre-commit output references These fixes ensure proper runtime behavior, improved security, and better cross-platform compatibility across all affected actions. * fix: resolve critical runtime and security issues across actions - Fix biome-fix files_changed calculation using git diff instead of git status delta - Fix compress-images output description and add absolute path validation - Remove csharp-publish token default and fix token fallback in push commands - Add @microsoft/eslint-formatter-sarif to all package managers in eslint-check - Fix eslint-check command syntax by using variable assignment - Improve node-setup Bun installation security and remove invalid frozen-lockfile flag - Fix pre-commit token validation by removing ineffective literal comparison - Fix prettier-fix token comparison and expand regex for all GitHub token types - Add version-file-parser regex validation safety and fix csproj wildcard handling These fixes address security vulnerabilities, runtime errors, and functional issues to ensure reliable operation across all affected GitHub Actions. * feat: enhance Docker actions with advanced multi-architecture support Major enhancement to Docker build and publish actions with comprehensive multi-architecture capabilities and enterprise-grade features. Added features: - Advanced buildx configuration (version control, cache modes, build contexts) - Auto-detect platforms for dynamic architecture discovery - Performance optimizations with enhanced caching strategies - Security scanning with Trivy and image signing with Cosign - SBOM generation in multiple formats with validation - Verbose logging and dry-run modes for debugging - Platform-specific build args and fallback mechanisms Enhanced all Docker actions: - docker-build: Core buildx features and multi-arch support - docker-publish-gh: GitHub Packages with security features - docker-publish-hub: Docker Hub with scanning and signing - docker-publish: Orchestrator with unified configuration Updated documentation across all modified actions. * fix: resolve documentation generation placeholder issue Fixed Makefile and package.json to properly replace placeholder tokens in generated documentation, ensuring all README files show correct repository paths instead of ***PROJECT***@***VERSION***. * chore: simplify github token validation * chore(lint): optional yamlfmt, config and fixes * feat: use relative `uses` names * feat: comprehensive testing infrastructure and Python validation system - Migrate from tests/ to _tests/ directory structure with ShellSpec framework - Add comprehensive validation system with Python-based input validation - Implement dual testing approach (ShellSpec + pytest) for complete coverage - Add modern Python tooling (uv, ruff, pytest-cov) and dependencies - Create centralized validation rules with automatic generation system - Update project configuration and build system for new architecture - Enhance documentation to reflect current testing capabilities This establishes a robust foundation for action validation and testing with extensive coverage across all GitHub Actions in the repository. * chore: remove Dockerfile for now * chore: code review fixes * feat: comprehensive GitHub Actions restructuring and tooling improvements This commit represents a major restructuring of the GitHub Actions monorepo with improved tooling, testing infrastructure, and comprehensive PR #186 review implementation. ## Major Changes ### 🔧 Development Tooling & Configuration - **Shellcheck integration**: Exclude shellspec test files from linting - Updated .pre-commit-config.yaml to exclude _tests/*.sh from shellcheck/shfmt - Modified Makefile shellcheck pattern to skip shellspec files - Updated CLAUDE.md documentation with proper exclusion syntax - **Testing infrastructure**: Enhanced Python validation framework - Fixed nested if statements and boolean parameter issues in validation.py - Improved code quality with explicit keyword arguments - All pre-commit hooks now passing ### 🏗️ Project Structure & Documentation - **Added Serena AI integration** with comprehensive project memories: - Project overview, structure, and technical stack documentation - Code style conventions and completion requirements - Comprehensive PR #186 review analysis and implementation tracking - **Enhanced configuration**: Updated .gitignore, .yamlfmt.yml, pyproject.toml - **Improved testing**: Added integration workflows and enhanced test specs ### 🚀 GitHub Actions Improvements (30+ actions updated) - **Centralized validation**: Updated 41 validation rule files - **Enhanced actions**: Improvements across all action categories: - Setup actions (node-setup, version detectors) - Utility actions (version-file-parser, version-validator) - Linting actions (biome, eslint, terraform-lint-fix major refactor) - Build/publish actions (docker-build, npm-publish, csharp-*) - Repository management actions ### 📝 Documentation Updates - **README consistency**: Updated version references across action READMEs - **Enhanced documentation**: Improved action descriptions and usage examples - **CLAUDE.md**: Updated with current tooling and best practices ## Technical Improvements - **Security enhancements**: Input validation and sanitization improvements - **Performance optimizations**: Streamlined action logic and dependencies - **Cross-platform compatibility**: Better Windows/macOS/Linux support - **Error handling**: Improved error reporting and user feedback ## Files Changed - 100 files changed - 13 new Serena memory files documenting project state - 41 validation rules updated for consistency - 30+ GitHub Actions and READMEs improved - Core tooling configuration enhanced * feat: comprehensive GitHub Actions improvements and PR review fixes Major Infrastructure Improvements: - Add comprehensive testing framework with 17+ ShellSpec validation tests - Implement Docker-based testing tools with automated test runner - Add CodeRabbit configuration for automated code reviews - Restructure documentation and memory management system - Update validation rules for 25+ actions with enhanced input validation - Modernize CI/CD workflows and testing infrastructure Critical PR Review Fixes (All Issues Resolved): - Fix double caching in node-setup (eliminate redundant cache operations) - Optimize shell pipeline in version-file-parser (single awk vs complex pipeline) - Fix GitHub expression interpolation in prettier-check cache keys - Resolve terraform command order issue (validation after setup) - Add missing flake8-sarif dependency for Python SARIF output - Fix environment variable scope in pr-lint (export to GITHUB_ENV) Performance & Reliability: - Eliminate duplicate cache operations saving CI time - Improve shell script efficiency with optimized parsing - Fix command execution dependencies preventing runtime failures - Ensure proper dependency installation for all linting tools - Resolve workflow conditional logic issues Security & Quality: - All input validation rules updated with latest security patterns - Cross-platform compatibility improvements maintained - Comprehensive error handling and retry logic preserved - Modern development tooling and best practices adopted This commit addresses 100% of actionable feedback from PR review analysis, implements comprehensive testing infrastructure, and maintains high code quality standards across all 41 GitHub Actions. * feat: enhance expression handling and version parsing - Fix node-setup force-version expression logic for proper empty string handling - Improve version-file-parser with secure regex validation and enhanced Python detection - Add CodeRabbit configuration for CalVer versioning and README review guidance * feat(validate-inputs): implement modular validation system - Add modular validator architecture with specialized validators - Implement base validator classes for different input types - Add validators: boolean, docker, file, network, numeric, security, token, version - Add convention mapper for automatic input validation - Add comprehensive documentation for the validation system - Implement PCRE regex support and injection protection * feat(validate-inputs): add validation rules for all actions - Add YAML validation rules for 42 GitHub Actions - Auto-generated rules with convention mappings - Include metadata for validation coverage and quality indicators - Mark rules as auto-generated to prevent manual edits * test(validate-inputs): add comprehensive test suite for validators - Add unit tests for all validator modules - Add integration tests for the validation system - Add fixtures for version test data - Test coverage for boolean, docker, file, network, numeric, security, token, and version validators - Add tests for convention mapper and registry * feat(tools): add validation scripts and utilities - Add update-validators.py script for auto-generating rules - Add benchmark-validator.py for performance testing - Add debug-validator.py for troubleshooting - Add generate-tests.py for test generation - Add check-rules-not-manually-edited.sh for CI validation - Add fix-local-action-refs.py tool for fixing action references * feat(actions): add CustomValidator.py files for specialized validation - Add custom validators for actions requiring special validation logic - Implement validators for docker, go, node, npm, php, python, terraform actions - Add specialized validation for compress-images, common-cache, common-file-check - Implement version detection validators with language-specific logic - Add validation for build arguments, architectures, and version formats * test: update ShellSpec test framework for Python validation - Update all validation.spec.sh files to use Python validator - Add shared validation_core.py for common test utilities - Remove obsolete bash validation helpers - Update test output expectations for Python validator format - Add codeql-analysis test suite - Refactor framework utilities for Python integration - Remove deprecated test files * feat(actions): update action.yml files to use validate-inputs - Replace inline bash validation with validate-inputs action - Standardize validation across all 42 actions - Add new codeql-analysis action - Update action metadata and branding - Add validation step as first step in composite actions - Maintain backward compatibility with existing inputs/outputs * ci: update GitHub workflows for enhanced security and testing - Add new codeql-new.yml workflow - Update security scanning workflows - Enhance dependency review configuration - Update test-actions workflow for new validation system - Improve workflow permissions and security settings - Update action versions to latest SHA-pinned releases * build: update build configuration and dependencies - Update Makefile with new validation targets - Add Python dependencies in pyproject.toml - Update npm dependencies and scripts - Enhance Docker testing tools configuration - Add targets for validator updates and local ref fixes - Configure uv for Python package management * chore: update linting and documentation configuration - Update EditorConfig settings for consistent formatting - Enhance pre-commit hooks configuration - Update prettier and yamllint ignore patterns - Update gitleaks security scanning rules - Update CodeRabbit review configuration - Update CLAUDE.md with latest project standards and rules * docs: update Serena memory files and project metadata - Remove obsolete PR-186 memory files - Update project overview with current architecture - Update project structure documentation - Add quality standards and communication guidelines - Add modular validator architecture documentation - Add shellspec testing framework documentation - Update project.yml with latest configuration * feat: moved rules.yml to same folder as action, fixes * fix(validators): correct token patterns and fix validator bugs - Fix GitHub classic PAT pattern: ghp_ + 36 chars = 40 total - Fix GitHub fine-grained PAT pattern: github_pat_ + 71 chars = 82 total - Initialize result variable in convention_mapper to prevent UnboundLocalError - Fix empty URL validation in network validator to return error - Add GitHub expression check to docker architectures validator - Update docker-build CustomValidator parallel-builds max to 16 * test(validators): fix test fixtures and expectations - Fix token lengths in test data: github_pat 71 chars, ghp/gho 36 chars - Update integration tests with correct token lengths - Fix file validator test to expect absolute paths rejected for security - Rename TestGenerator import to avoid pytest collection warning - Update custom validator tests with correct input names - Change docker-build tests: platforms->architectures, tags->tag - Update docker-publish tests to match new registry enum validation * test(shellspec): fix token lengths in test helpers and specs - Fix default token lengths in spec_helper.sh to use correct 40-char format - Update csharp-publish default tokens in 4 locations - Update codeql-analysis default tokens in 2 locations - Fix codeql-analysis test tokens to correct lengths (40 and 82 chars) - Fix npm-publish fine-grained token test to use 82-char format * feat(actions): add permissions documentation and environment variable usage - Add permissions comments to all action.yml files documenting required GitHub permissions - Convert direct input usage to environment variables in shell steps for security - Add validation steps with proper error handling - Update input descriptions and add security notes where applicable - Ensure all actions follow consistent patterns for input validation * chore(workflows): update GitHub Actions workflow versions - Update workflow action versions to latest - Improve workflow consistency and maintainability * docs(security): add comprehensive security policy - Document security features and best practices - Add vulnerability reporting process - Include audit history and security testing information * docs(memory): add GitHub workflow reference documentation - Add GitHub Actions workflow commands reference - Add GitHub workflow expressions guide - Add secure workflow usage patterns and best practices * chore: token optimization, code style conventions * chore: cr fixes * fix: trivy reported Dockerfile problems * fix(security): more security fixes * chore: dockerfile and make targets for publishing * fix(ci): add creds to test-actions workflow * fix: security fix and checkout step to codeql-new * chore: test fixes * fix(security): codeql detected issues * chore: code review fixes, ReDos protection * style: apply MegaLinter fixes * fix(ci): missing packages read permission * fix(ci): add missing working directory setting * chore: linting, add validation-regex to use regex_pattern * chore: code review fixes * chore(deps): update actions * fix(security): codeql fixes * chore(cr): apply cr comments * chore: improve POSIX compatibility * chore(cr): apply cr comments * fix: codeql warning in Dockerfile, build failures * chore(cr): apply cr comments * fix: docker-testing-tools/Dockerfile * chore(cr): apply cr comments * fix(docker): update testing-tools image for GitHub Actions compatibility * chore(cr): apply cr comments * feat: add more tests, fix issues * chore: fix codeql issues, update actions * chore(cr): apply cr comments * fix: integration tests * chore: deduplication and fixes * style: apply MegaLinter fixes * chore(cr): apply cr comments * feat: dry-run mode for generate-tests * fix(ci): kcov installation * chore(cr): apply cr comments * chore(cr): apply cr comments * chore(cr): apply cr comments * chore(cr): apply cr comments, simplify action testing, use uv * fix: run-tests.sh action counting * chore(cr): apply cr comments * chore(cr): apply cr comments
This commit is contained in:
GitHub
256
eslint-check/CustomValidator.py
Executable file
256
eslint-check/CustomValidator.py
Executable file
@@ -0,0 +1,256 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Custom validator for eslint-check action."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
import re
|
||||
import sys
|
||||
|
||||
# Add validate-inputs directory to path to import validators
|
||||
validate_inputs_path = Path(__file__).parent.parent / "validate-inputs"
|
||||
sys.path.insert(0, str(validate_inputs_path))
|
||||
|
||||
from validators.base import BaseValidator
|
||||
from validators.boolean import BooleanValidator
|
||||
from validators.file import FileValidator
|
||||
from validators.numeric import NumericValidator
|
||||
from validators.version import VersionValidator
|
||||
|
||||
|
||||
class CustomValidator(BaseValidator):
|
||||
"""Custom validator for eslint-check action."""
|
||||
|
||||
def __init__(self, action_type: str = "eslint-check") -> None:
|
||||
"""Initialize eslint-check validator."""
|
||||
super().__init__(action_type)
|
||||
self.file_validator = FileValidator()
|
||||
self.version_validator = VersionValidator()
|
||||
self.boolean_validator = BooleanValidator()
|
||||
self.numeric_validator = NumericValidator()
|
||||
|
||||
def validate_inputs(self, inputs: dict[str, str]) -> bool:
|
||||
"""Validate eslint-check action inputs."""
|
||||
valid = True
|
||||
|
||||
# Validate working-directory if provided
|
||||
if inputs.get("working-directory"):
|
||||
result = self.file_validator.validate_file_path(
|
||||
inputs["working-directory"], "working-directory"
|
||||
)
|
||||
for error in self.file_validator.errors:
|
||||
if error not in self.errors:
|
||||
self.add_error(error)
|
||||
self.file_validator.clear_errors()
|
||||
if not result:
|
||||
valid = False
|
||||
|
||||
# Validate eslint-version if provided
|
||||
if "eslint-version" in inputs:
|
||||
value = inputs["eslint-version"]
|
||||
# Check for empty version - reject it
|
||||
if value == "":
|
||||
self.add_error("ESLint version cannot be empty")
|
||||
valid = False
|
||||
# Allow "latest" as a special case
|
||||
elif value == "latest":
|
||||
pass # Valid
|
||||
# Validate as semantic version (eslint uses strict semantic versioning)
|
||||
elif value and not value.startswith("${{"):
|
||||
# ESLint requires full semantic version (X.Y.Z), not partial versions
|
||||
if not re.match(r"^\d+\.\d+\.\d+", value):
|
||||
self.add_error(
|
||||
f"ESLint version must be a complete semantic version (X.Y.Z), got: {value}"
|
||||
)
|
||||
valid = False
|
||||
else:
|
||||
result = self.version_validator.validate_semantic_version(
|
||||
value, "eslint-version"
|
||||
)
|
||||
for error in self.version_validator.errors:
|
||||
if error not in self.errors:
|
||||
self.add_error(error)
|
||||
self.version_validator.clear_errors()
|
||||
if not result:
|
||||
valid = False
|
||||
|
||||
# Validate config-file if provided
|
||||
if inputs.get("config-file"):
|
||||
result = self.file_validator.validate_file_path(inputs["config-file"], "config-file")
|
||||
for error in self.file_validator.errors:
|
||||
if error not in self.errors:
|
||||
self.add_error(error)
|
||||
self.file_validator.clear_errors()
|
||||
if not result:
|
||||
valid = False
|
||||
|
||||
# Validate ignore-file if provided
|
||||
if inputs.get("ignore-file"):
|
||||
result = self.file_validator.validate_file_path(inputs["ignore-file"], "ignore-file")
|
||||
for error in self.file_validator.errors:
|
||||
if error not in self.errors:
|
||||
self.add_error(error)
|
||||
self.file_validator.clear_errors()
|
||||
if not result:
|
||||
valid = False
|
||||
|
||||
# Validate ignore-file if provided
|
||||
if inputs.get("ignore-file"):
|
||||
result = self.file_validator.validate_file_path(inputs["ignore-file"], "ignore-file")
|
||||
for error in self.file_validator.errors:
|
||||
if error not in self.errors:
|
||||
self.add_error(error)
|
||||
self.file_validator.clear_errors()
|
||||
if not result:
|
||||
valid = False
|
||||
|
||||
# Validate file-extensions if provided
|
||||
if inputs.get("file-extensions"):
|
||||
value = inputs["file-extensions"]
|
||||
# Check for valid extension format
|
||||
extensions = value.split(",") if "," in value else value.split()
|
||||
for ext in extensions:
|
||||
ext = ext.strip()
|
||||
if ext and not ext.startswith("${{"):
|
||||
# Extensions should start with a dot
|
||||
if not ext.startswith("."):
|
||||
self.add_error(f"Extension '{ext}' should start with a dot")
|
||||
valid = False
|
||||
# Check for invalid characters
|
||||
elif not re.match(r"^\.[a-zA-Z0-9]+$", ext):
|
||||
self.add_error(f"Invalid extension format: {ext}")
|
||||
valid = False
|
||||
|
||||
# Validate cache boolean
|
||||
if inputs.get("cache"):
|
||||
result = self.boolean_validator.validate_boolean(inputs["cache"], "cache")
|
||||
for error in self.boolean_validator.errors:
|
||||
if error not in self.errors:
|
||||
self.add_error(error)
|
||||
self.boolean_validator.clear_errors()
|
||||
if not result:
|
||||
valid = False
|
||||
|
||||
# Validate max-warnings numeric
|
||||
if inputs.get("max-warnings"):
|
||||
value = inputs["max-warnings"]
|
||||
if value and not value.startswith("${{"):
|
||||
try:
|
||||
num_value = int(value)
|
||||
if num_value < 0:
|
||||
self.add_error(f"max-warnings cannot be negative: {value}")
|
||||
valid = False
|
||||
except ValueError:
|
||||
self.add_error(f"max-warnings must be a number: {value}")
|
||||
valid = False
|
||||
|
||||
# Validate fail-on-error boolean
|
||||
if inputs.get("fail-on-error"):
|
||||
result = self.boolean_validator.validate_boolean(
|
||||
inputs["fail-on-error"], "fail-on-error"
|
||||
)
|
||||
for error in self.boolean_validator.errors:
|
||||
if error not in self.errors:
|
||||
self.add_error(error)
|
||||
self.boolean_validator.clear_errors()
|
||||
if not result:
|
||||
valid = False
|
||||
|
||||
# Validate report-format
|
||||
if "report-format" in inputs:
|
||||
value = inputs["report-format"]
|
||||
valid_formats = [
|
||||
"stylish",
|
||||
"compact",
|
||||
"json",
|
||||
"junit",
|
||||
"html",
|
||||
"table",
|
||||
"tap",
|
||||
"unix",
|
||||
"sarif",
|
||||
"checkstyle",
|
||||
]
|
||||
if value == "":
|
||||
self.add_error("Report format cannot be empty")
|
||||
valid = False
|
||||
elif value and not value.startswith("${{"):
|
||||
if value not in valid_formats:
|
||||
self.add_error(
|
||||
f"Invalid report format: {value}. "
|
||||
f"Must be one of: {', '.join(valid_formats)}"
|
||||
)
|
||||
valid = False
|
||||
|
||||
# Validate max-retries
|
||||
if inputs.get("max-retries"):
|
||||
value = inputs["max-retries"]
|
||||
if value and not value.startswith("${{"):
|
||||
result = self.numeric_validator.validate_numeric_range_1_10(value, "max-retries")
|
||||
for error in self.numeric_validator.errors:
|
||||
if error not in self.errors:
|
||||
self.add_error(error)
|
||||
self.numeric_validator.clear_errors()
|
||||
if not result:
|
||||
valid = False
|
||||
|
||||
return valid
|
||||
|
||||
def get_required_inputs(self) -> list[str]:
|
||||
"""Get list of required inputs."""
|
||||
return []
|
||||
|
||||
def get_validation_rules(self) -> dict:
|
||||
"""Get validation rules."""
|
||||
return {
|
||||
"working-directory": {
|
||||
"type": "directory",
|
||||
"required": False,
|
||||
"description": "Working directory",
|
||||
},
|
||||
"eslint-version": {
|
||||
"type": "flexible_version",
|
||||
"required": False,
|
||||
"description": "ESLint version",
|
||||
},
|
||||
"config-file": {
|
||||
"type": "file",
|
||||
"required": False,
|
||||
"description": "ESLint config file",
|
||||
},
|
||||
"ignore-file": {
|
||||
"type": "file",
|
||||
"required": False,
|
||||
"description": "ESLint ignore file",
|
||||
},
|
||||
"file-extensions": {
|
||||
"type": "string",
|
||||
"required": False,
|
||||
"description": "File extensions to check",
|
||||
},
|
||||
"cache": {
|
||||
"type": "boolean",
|
||||
"required": False,
|
||||
"description": "Enable caching",
|
||||
},
|
||||
"max-warnings": {
|
||||
"type": "numeric",
|
||||
"required": False,
|
||||
"description": "Maximum warnings allowed",
|
||||
},
|
||||
"fail-on-error": {
|
||||
"type": "boolean",
|
||||
"required": False,
|
||||
"description": "Fail on error",
|
||||
},
|
||||
"report-format": {
|
||||
"type": "string",
|
||||
"required": False,
|
||||
"description": "Report format",
|
||||
},
|
||||
"max-retries": {
|
||||
"type": "numeric",
|
||||
"required": False,
|
||||
"description": "Maximum retry count",
|
||||
},
|
||||
}
|
||||
@@ -1,5 +1,8 @@
|
||||
---
|
||||
# yaml-language-server: $schema=https://json.schemastore.org/github-action.json
|
||||
# permissions:
|
||||
# - security-events: write # Required for uploading SARIF results
|
||||
# - contents: read # Required for checking out repository
|
||||
---
|
||||
name: ESLint Check
|
||||
description: 'Run ESLint check on the repository with advanced configuration and reporting'
|
||||
author: Ismo Vuorinen
|
||||
@@ -70,66 +73,192 @@ runs:
|
||||
- name: Validate Inputs
|
||||
id: validate
|
||||
shell: bash
|
||||
env:
|
||||
WORKING_DIRECTORY: ${{ inputs.working-directory }}
|
||||
ESLINT_VERSION: ${{ inputs.eslint-version }}
|
||||
CONFIG_FILE: ${{ inputs.config-file }}
|
||||
IGNORE_FILE: ${{ inputs.ignore-file }}
|
||||
FILE_EXTENSIONS: ${{ inputs.file-extensions }}
|
||||
CACHE: ${{ inputs.cache }}
|
||||
FAIL_ON_ERROR: ${{ inputs.fail-on-error }}
|
||||
MAX_WARNINGS: ${{ inputs.max-warnings }}
|
||||
REPORT_FORMAT: ${{ inputs.report-format }}
|
||||
MAX_RETRIES: ${{ inputs.max-retries }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
# Validate working directory
|
||||
if [ ! -d "${{ inputs.working-directory }}" ]; then
|
||||
echo "::error::Working directory does not exist: ${{ inputs.working-directory }}"
|
||||
# Validate working directory exists
|
||||
if [ ! -d "$WORKING_DIRECTORY" ]; then
|
||||
echo "::error::Working directory not found at '$WORKING_DIRECTORY'"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Validate file extensions
|
||||
if ! [[ "${{ inputs.file-extensions }}" =~ ^[.,a-zA-Z0-9]+$ ]]; then
|
||||
echo "::error::Invalid file extensions format"
|
||||
# Validate working directory path security (prevent traversal)
|
||||
if [[ "$WORKING_DIRECTORY" == *".."* ]]; then
|
||||
echo "::error::Invalid working directory path: '$WORKING_DIRECTORY'. Path traversal not allowed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Validate max warnings
|
||||
if ! [[ "${{ inputs.max-warnings }}" =~ ^[0-9]+$ ]]; then
|
||||
echo "::error::Invalid max warnings value"
|
||||
# Validate ESLint version format
|
||||
if [[ -n "$ESLINT_VERSION" ]] && [[ "$ESLINT_VERSION" != "latest" ]]; then
|
||||
if ! [[ "$ESLINT_VERSION" =~ ^[0-9]+(\.[0-9]+(\.[0-9]+)?)?(-[a-zA-Z0-9.-]+)?$ ]]; then
|
||||
echo "::error::Invalid eslint-version format: '$ESLINT_VERSION'. Expected format: X.Y.Z or 'latest' (e.g., 8.57.0, latest)"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Validate config file path if not default
|
||||
if [[ "$CONFIG_FILE" != ".eslintrc" ]] && [[ "$CONFIG_FILE" == *".."* ]]; then
|
||||
echo "::error::Invalid config file path: '$CONFIG_FILE'. Path traversal not allowed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Validate ignore file path if not default
|
||||
if [[ "$IGNORE_FILE" != ".eslintignore" ]] && [[ "$IGNORE_FILE" == *".."* ]]; then
|
||||
echo "::error::Invalid ignore file path: '$IGNORE_FILE'. Path traversal not allowed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Validate file extensions format
|
||||
if ! [[ "$FILE_EXTENSIONS" =~ ^(\.[a-zA-Z0-9]+)(,\.[a-zA-Z0-9]+)*$ ]]; then
|
||||
echo "::error::Invalid file extensions format: '$FILE_EXTENSIONS'. Expected format: .js,.jsx,.ts,.tsx"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Validate boolean inputs
|
||||
validate_boolean() {
|
||||
local value="$1"
|
||||
local name="$2"
|
||||
|
||||
case "${value,,}" in
|
||||
true|false)
|
||||
;;
|
||||
*)
|
||||
echo "::error::Invalid boolean value for $name: '$value'. Expected: true or false"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
validate_boolean "$CACHE" "cache"
|
||||
validate_boolean "$FAIL_ON_ERROR" "fail-on-error"
|
||||
|
||||
# Validate max warnings (positive integer)
|
||||
if ! [[ "$MAX_WARNINGS" =~ ^[0-9]+$ ]]; then
|
||||
echo "::error::Invalid max-warnings: '$MAX_WARNINGS'. Must be a non-negative integer (e.g., 0, 10)"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Validate report format enumerated values
|
||||
case "$REPORT_FORMAT" in
|
||||
stylish|json|sarif|checkstyle|compact|html|jslint-xml|junit|tap|unix)
|
||||
;;
|
||||
*)
|
||||
echo "::error::Invalid report-format: '$REPORT_FORMAT'. Allowed values: stylish, json, sarif, checkstyle, compact, html, jslint-xml, junit, tap, unix"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
# Validate max retries (positive integer with reasonable upper limit)
|
||||
if ! [[ "$MAX_RETRIES" =~ ^[0-9]+$ ]] || [ "$MAX_RETRIES" -le 0 ] || [ "$MAX_RETRIES" -gt 10 ]; then
|
||||
echo "::error::Invalid max-retries: '$MAX_RETRIES'. Must be a positive integer between 1 and 10"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: ivuorinen/actions/node-setup@main
|
||||
id: node-setup
|
||||
uses: ./node-setup
|
||||
|
||||
- name: Cache Node Dependencies
|
||||
id: cache
|
||||
uses: ./common-cache
|
||||
with:
|
||||
type: 'npm'
|
||||
paths: 'node_modules'
|
||||
key-files: 'package-lock.json,yarn.lock,pnpm-lock.yaml,bun.lockb'
|
||||
key-prefix: 'eslint-check-${{ steps.node-setup.outputs.package-manager }}'
|
||||
|
||||
- name: Install Dependencies
|
||||
if: steps.cache.outputs.cache-hit != 'true'
|
||||
shell: bash
|
||||
env:
|
||||
WORKING_DIRECTORY: ${{ inputs.working-directory }}
|
||||
PACKAGE_MANAGER: ${{ steps.node-setup.outputs.package-manager }}
|
||||
MAX_RETRIES: ${{ inputs.max-retries }}
|
||||
ESLINT_VERSION: ${{ inputs.eslint-version }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
cd ${{ inputs.working-directory }}
|
||||
cd "$WORKING_DIRECTORY"
|
||||
|
||||
# Install ESLint and required dependencies
|
||||
echo "Installing ESLint dependencies..."
|
||||
echo "Installing ESLint dependencies using $PACKAGE_MANAGER..."
|
||||
|
||||
# Function to install with retries
|
||||
install_with_retries() {
|
||||
local attempt=1
|
||||
local max_attempts=${{ inputs.max-retries }}
|
||||
|
||||
while [ $attempt -le $max_attempts ]; do
|
||||
echo "Installation attempt $attempt of $max_attempts"
|
||||
while [ $attempt -le "$MAX_RETRIES" ]; do
|
||||
echo "Installation attempt $attempt of $MAX_RETRIES"
|
||||
|
||||
if npm install \
|
||||
eslint@${{ inputs.eslint-version }} \
|
||||
@typescript-eslint/parser \
|
||||
@typescript-eslint/eslint-plugin \
|
||||
eslint-plugin-import \
|
||||
eslint-config-prettier \
|
||||
typescript; then
|
||||
return 0
|
||||
fi
|
||||
case "$PACKAGE_MANAGER" in
|
||||
"pnpm")
|
||||
if pnpm add -D \
|
||||
"eslint@$ESLINT_VERSION" \
|
||||
@typescript-eslint/parser \
|
||||
@typescript-eslint/eslint-plugin \
|
||||
@microsoft/eslint-formatter-sarif \
|
||||
eslint-plugin-import \
|
||||
eslint-config-prettier \
|
||||
typescript; then
|
||||
return 0
|
||||
fi
|
||||
;;
|
||||
"yarn")
|
||||
if yarn add -D \
|
||||
"eslint@$ESLINT_VERSION" \
|
||||
@typescript-eslint/parser \
|
||||
@typescript-eslint/eslint-plugin \
|
||||
@microsoft/eslint-formatter-sarif \
|
||||
eslint-plugin-import \
|
||||
eslint-config-prettier \
|
||||
typescript; then
|
||||
return 0
|
||||
fi
|
||||
;;
|
||||
"bun")
|
||||
if bun add -D \
|
||||
"eslint@$ESLINT_VERSION" \
|
||||
@typescript-eslint/parser \
|
||||
@typescript-eslint/eslint-plugin \
|
||||
@microsoft/eslint-formatter-sarif \
|
||||
eslint-plugin-import \
|
||||
eslint-config-prettier \
|
||||
typescript; then
|
||||
return 0
|
||||
fi
|
||||
;;
|
||||
"npm"|*)
|
||||
if npm install \
|
||||
"eslint@$ESLINT_VERSION" \
|
||||
@typescript-eslint/parser \
|
||||
@typescript-eslint/eslint-plugin \
|
||||
@microsoft/eslint-formatter-sarif \
|
||||
eslint-plugin-import \
|
||||
eslint-config-prettier \
|
||||
typescript; then
|
||||
return 0
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
|
||||
attempt=$((attempt + 1))
|
||||
if [ $attempt -le $max_attempts ]; then
|
||||
if [ $attempt -le "$MAX_RETRIES" ]; then
|
||||
echo "Installation failed, waiting 10 seconds before retry..."
|
||||
sleep 10
|
||||
fi
|
||||
done
|
||||
|
||||
echo "::error::Failed to install dependencies after $max_attempts attempts"
|
||||
echo "::error::Failed to install dependencies after $MAX_RETRIES attempts"
|
||||
return 1
|
||||
}
|
||||
|
||||
@@ -138,15 +267,19 @@ runs:
|
||||
- name: Prepare ESLint Configuration
|
||||
id: config
|
||||
shell: bash
|
||||
env:
|
||||
WORKING_DIRECTORY: ${{ inputs.working-directory }}
|
||||
CONFIG_FILE: ${{ inputs.config-file }}
|
||||
IGNORE_FILE: ${{ inputs.ignore-file }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
cd ${{ inputs.working-directory }}
|
||||
cd "$WORKING_DIRECTORY"
|
||||
|
||||
# Create default config if none exists
|
||||
if [ ! -f "${{ inputs.config-file }}" ]; then
|
||||
if [ ! -f "$CONFIG_FILE" ]; then
|
||||
echo "Creating default ESLint configuration..."
|
||||
cat > "${{ inputs.config-file }}" <<EOF
|
||||
cat > "$CONFIG_FILE" <<EOF
|
||||
{
|
||||
"root": true,
|
||||
"extends": [
|
||||
@@ -172,9 +305,9 @@ runs:
|
||||
fi
|
||||
|
||||
# Create default ignore file if none exists
|
||||
if [ ! -f "${{ inputs.ignore-file }}" ]; then
|
||||
if [ ! -f "$IGNORE_FILE" ]; then
|
||||
echo "Creating default ESLint ignore file..."
|
||||
cat > "${{ inputs.ignore-file }}" <<EOF
|
||||
cat > "$IGNORE_FILE" <<EOF
|
||||
node_modules/
|
||||
dist/
|
||||
build/
|
||||
@@ -186,36 +319,69 @@ runs:
|
||||
- name: Run ESLint Check
|
||||
id: lint
|
||||
shell: bash
|
||||
env:
|
||||
WORKING_DIRECTORY: ${{ inputs.working-directory }}
|
||||
FILE_EXTENSIONS: ${{ inputs.file-extensions }}
|
||||
PACKAGE_MANAGER: ${{ steps.node-setup.outputs.package-manager }}
|
||||
CONFIG_FILE: ${{ inputs.config-file }}
|
||||
IGNORE_FILE: ${{ inputs.ignore-file }}
|
||||
CACHE: ${{ inputs.cache }}
|
||||
MAX_WARNINGS: ${{ inputs.max-warnings }}
|
||||
REPORT_FORMAT: ${{ inputs.report-format }}
|
||||
FAIL_ON_ERROR: ${{ inputs.fail-on-error }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
cd ${{ inputs.working-directory }}
|
||||
cd "$WORKING_DIRECTORY"
|
||||
|
||||
# Create reports directory
|
||||
mkdir -p reports
|
||||
|
||||
# Prepare file extensions for ESLint
|
||||
IFS=',' read -ra EXTENSIONS <<< "${{ inputs.file-extensions }}"
|
||||
IFS=',' read -ra EXTENSIONS <<< "$FILE_EXTENSIONS"
|
||||
ext_pattern=""
|
||||
for ext in "${EXTENSIONS[@]}"; do
|
||||
ext_pattern="$ext_pattern --ext $ext"
|
||||
done
|
||||
|
||||
# Run ESLint
|
||||
echo "Running ESLint..."
|
||||
npx eslint \
|
||||
$ext_pattern \
|
||||
--config ${{ inputs.config-file }} \
|
||||
--ignore-path ${{ inputs.ignore-file }} \
|
||||
${{ inputs.cache == 'true' && '--cache' || '' }} \
|
||||
--max-warnings ${{ inputs.max-warnings }} \
|
||||
--format=${{ inputs.report-format }} \
|
||||
--output-file=reports/eslint.${{ inputs.report-format }} \
|
||||
echo "Running ESLint with $PACKAGE_MANAGER..."
|
||||
|
||||
# Build ESLint command based on package manager
|
||||
case "$PACKAGE_MANAGER" in
|
||||
"pnpm")
|
||||
eslint_cmd="pnpm exec eslint"
|
||||
;;
|
||||
"yarn")
|
||||
eslint_cmd="yarn eslint"
|
||||
;;
|
||||
"bun")
|
||||
eslint_cmd="bunx eslint"
|
||||
;;
|
||||
"npm"|*)
|
||||
eslint_cmd="npx eslint"
|
||||
;;
|
||||
esac
|
||||
|
||||
# Prepare cache flag
|
||||
cache_flag=""
|
||||
if [ "$CACHE" = "true" ]; then
|
||||
cache_flag="--cache"
|
||||
fi
|
||||
|
||||
# Execute ESLint with all arguments
|
||||
$eslint_cmd $ext_pattern \
|
||||
--config "$CONFIG_FILE" \
|
||||
--ignore-path "$IGNORE_FILE" \
|
||||
${cache_flag} \
|
||||
--max-warnings "$MAX_WARNINGS" \
|
||||
--format="$REPORT_FORMAT" \
|
||||
--output-file="reports/eslint.$REPORT_FORMAT" \
|
||||
. || {
|
||||
error_code=$?
|
||||
|
||||
# Count errors and warnings
|
||||
if [ "${{ inputs.report-format }}" = "json" ]; then
|
||||
if [ "$REPORT_FORMAT" = "json" ]; then
|
||||
error_count=$(jq '[.[] | .errorCount] | add' reports/eslint.json)
|
||||
warning_count=$(jq '[.[] | .warningCount] | add' reports/eslint.json)
|
||||
else
|
||||
@@ -226,7 +392,7 @@ runs:
|
||||
echo "error_count=${error_count}" >> $GITHUB_OUTPUT
|
||||
echo "warning_count=${warning_count}" >> $GITHUB_OUTPUT
|
||||
|
||||
if [ "${{ inputs.fail-on-error }}" = "true" ] && [ $error_code -ne 0 ]; then
|
||||
if [ "$FAIL_ON_ERROR" = "true" ] && [ $error_code -ne 0 ]; then
|
||||
echo "::error::ESLint found ${error_count} errors and ${warning_count} warnings"
|
||||
exit $error_code
|
||||
fi
|
||||
@@ -239,7 +405,7 @@ runs:
|
||||
|
||||
- name: Upload ESLint Results
|
||||
if: always() && inputs.report-format == 'sarif'
|
||||
uses: github/codeql-action/upload-sarif@64d10c13136e1c5bce3e5fbde8d4906eeaafc885 # v3.30.6
|
||||
uses: github/codeql-action/upload-sarif@f443b600d91635bebf5b0d9ebc620189c0d6fba5 # v4.30.8
|
||||
with:
|
||||
sarif_file: ${{ inputs.working-directory }}/reports/eslint.sarif
|
||||
category: eslint
|
||||
@@ -247,10 +413,12 @@ runs:
|
||||
- name: Cache Cleanup
|
||||
if: always()
|
||||
shell: bash
|
||||
run: |
|
||||
env:
|
||||
WORKING_DIRECTORY: ${{ inputs.working-directory }}
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
cd ${{ inputs.working-directory }}
|
||||
cd "$WORKING_DIRECTORY"
|
||||
|
||||
# Clean up ESLint cache if it exists
|
||||
if [ -f ".eslintcache" ]; then
|
||||
|
||||
53
eslint-check/rules.yml
Normal file
53
eslint-check/rules.yml
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
# Validation rules for eslint-check action
|
||||
# Generated by update-validators.py v1.0.0 - DO NOT EDIT MANUALLY
|
||||
# Schema version: 1.0
|
||||
# Coverage: 100% (10/10 inputs)
|
||||
#
|
||||
# This file defines validation rules for the eslint-check GitHub Action.
|
||||
# Rules are automatically applied by validate-inputs action when this
|
||||
# action is used.
|
||||
#
|
||||
|
||||
schema_version: '1.0'
|
||||
action: eslint-check
|
||||
description: Run ESLint check on the repository with advanced configuration and reporting
|
||||
generator_version: 1.0.0
|
||||
required_inputs: []
|
||||
optional_inputs:
|
||||
- cache
|
||||
- config-file
|
||||
- eslint-version
|
||||
- fail-on-error
|
||||
- file-extensions
|
||||
- ignore-file
|
||||
- max-retries
|
||||
- max-warnings
|
||||
- report-format
|
||||
- working-directory
|
||||
conventions:
|
||||
cache: boolean
|
||||
config-file: file_path
|
||||
eslint-version: strict_semantic_version
|
||||
fail-on-error: boolean
|
||||
file-extensions: file_extensions
|
||||
ignore-file: file_path
|
||||
max-retries: numeric_range_1_10
|
||||
max-warnings: numeric_range_0_10000
|
||||
report-format: report_format
|
||||
working-directory: file_path
|
||||
overrides: {}
|
||||
statistics:
|
||||
total_inputs: 10
|
||||
validated_inputs: 10
|
||||
skipped_inputs: 0
|
||||
coverage_percentage: 100
|
||||
validation_coverage: 100
|
||||
auto_detected: true
|
||||
manual_review_required: false
|
||||
quality_indicators:
|
||||
has_required_inputs: false
|
||||
has_token_validation: false
|
||||
has_version_validation: true
|
||||
has_file_validation: true
|
||||
has_security_validation: false
|
||||
Reference in New Issue
Block a user