ansible/ansible-lint
Ansible Lint
ansible-lint is a static code analysis tool and linter designed to identify syntax errors and best practice violations within Ansible playbooks and roles. It functions as a quality gate for automation pipelines, scanning configuration files and scripts without executing the code to ensure reliability and consistency.
The project distinguishes itself by acting as an automated code formatter that can correct identified linting issues and reformat files to meet community standards. It also serves as a dependency manager, automatically detecting and installing required roles and collections from requirements files to ensure comprehensive analysis of the codebase.
The tool provides extensive rule management, allowing for the use of custom rule sets, tag-based filtering, and the suppression of false positives through inline comments. It further supports infrastructure standardization by identifying outdated code patterns for version migrations and exporting analysis results in structured formats like SARIF and JSON.
Integration is provided for continuous integration workflows, including specific support for GitHub Actions.
Features
- Static Analysis Rules - Analyzes configuration files using predefined logic patterns to detect syntax errors and best practice violations.
- Ansible Linters - Analyzes Ansible playbooks and roles to identify syntax errors and best practice violations.
- Code Quality and Analysis - Scans configuration files and roles to identify common pitfalls and ensure adherence to best practices.
- Playbook Analysis - Evaluates automation scripts and collections for syntax errors and best practice violations.
- Dependency-Aware Code Analysis - Ensures comprehensive analysis by automatically resolving and installing required roles and collections from requirements files.
- Dependency Installers - Automatically detects and installs required external roles and collections from requirements files for comprehensive analysis.
- Playbook Quality Analysis - Checks automation scripts for syntax errors and best practice violations to ensure reliable deployments.
- Coding Standards Enforcement - Maintains project quality by automatically identifying syntax errors, deprecated modules, and naming inconsistencies.
- Static Code Analysis Tools - Examines configuration files and automation scripts without executing them to find bugs and style violations.
- AST-Based Source Transformations - Provides automated correction of linting violations by transforming the source code via abstract syntax tree manipulation.
- Automated Lint Fixes - Provides automated fixing of linting violations to quickly align code with project standards.
- Automatic Code Formatters - Automatically corrects identified linting issues and reformats files to adhere to community style standards.
- Per-Rule Configurations - Bypasses designated rules for a project to prevent unwanted warnings and facilitate gradual content updates.
- Custom Lint Rule Plugins - Loads external rule directories as plugins to extend default validation logic with project-specific requirements.
- Custom Lint Rule Definitions - Provides interfaces for defining and disabling specific linting rules to align with project-specific requirements.
- Dependency Caches - Stores installed roles, collections, and modules locally to reduce the time spent on subsequent validation runs.
- Ansible Dependency Resolvers - Automatically detects and installs required external roles and collections to ensure complete analysis of the codebase.
- Local Dependency Caching - Stores downloaded roles and collections in a persistent local cache to accelerate subsequent validation cycles.
- Version Migration Scripts - Identifies outdated code patterns and incompatible modules to streamline the upgrade process to newer Ansible versions.
- CI Pipeline Integrations - Runs automated style and practice checks within continuous integration workflows to verify code quality before merging.
- Continuous Integration Checks - Integrates linting and quality checks directly into continuous integration pipelines to verify code before merging.
- Tag-Based Rule Filtering - Enables including or excluding groups of rules based on categories such as security, idempotency, or formatting.
- Migration Analysis Tools - Identifies code patterns incompatible with newer engine versions to streamline the migration process.
- Configuration Audits - Provides automated checks of configuration files to identify security misconfigurations and reliability pitfalls based on community standards.
- Plugin-Based Style Rule Extensions - Enables the addition of custom validation and formatting rules through external plugin directories.
- GitHub Actions - Integrates playbook verification into GitHub delivery pipelines to validate best practices during pull requests.
- Codebase Standardization - Enforces uniform formatting and naming conventions across Ansible roles and collections to maintain codebase consistency.
- Quality Profiles - Enforces different levels of strictness ranging from minimal syntax checks to production-ready reliability standards.
- Rule Suppression Comments - Allows disabling specific linting rules for targeted lines or blocks using inline source code comments.
- Quality Gates - Acts as a verification step in automation pipelines to prevent the merging of code that violates quality standards.
- Infrastructure Configuration Audits - Analyzes configuration files for non-standard practices and behavioral improvements to ensure quality.
