https://github.com/the-common/ansible-lint-configuration-template

Ready-to-use Ansible-lint configuration file at your fingertips!
https://github.com/the-common/ansible-lint-configuration-template

ansible ansible-lint config-template

Last synced: 13 days ago
JSON representation

Ready-to-use Ansible-lint configuration file at your fingertips!

• Host: GitHub
• URL: https://github.com/the-common/ansible-lint-configuration-template
• Owner: the-common
• Created: 2024-08-27T02:54:04.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-08-27T17:44:06.000Z (4 months ago)
• Last Synced: 2024-11-02T16:26:05.903Z (2 months ago)
• Topics: ansible, ansible-lint, config-template
• Language: Shell
• Homepage: https://gitlab.com/the-common/ansible-lint-configuration-template
• Size: 31.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSES/CC-BY-SA-4.0.txt

Awesome Lists containing this project

README

        
# The common Ansible-lint configuration template

Ready-to-use Ansible-lint configuration file at your fingertips!

  

[![The GitLab CI pipeline status badge of the project's `main` branch](https://gitlab.com/the-common/ansible-lint-configuration-template/badges/main/pipeline.svg?ignore_skipped=true "Click here to check out the comprehensive status of the GitLab CI pipelines")](https://gitlab.com/the-common/ansible-lint-configuration-template/-/pipelines) [![GitHub Actions workflow status badge](https://github.com/the-common/ansible-lint-configuration-template/actions/workflows/check-potential-problems.yml/badge.svg "GitHub Actions workflow status")](https://github.com/the-common/ansible-lint-configuration-template/actions/workflows/check-potential-problems.yml) [![pre-commit enabled badge](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white "This project uses pre-commit to check potential problems")](https://pre-commit.com/) [![REUSE Specification compliance badge](https://api.reuse.software/badge/gitlab.com/the-common/ansible-lint-configuration-template "This project complies to the REUSE specification to decrease software licensing costs")](https://api.reuse.software/info/gitlab.com/the-common/ansible-lint-configuration-template)

## Usage

1. Download the release package from [the project's Releases page](https://gitlab.com/the-common/ansible-lint-configuration-template/-/releases).

1. Extract the downloaded release package.

1. Install [the template.ansible-lint.yml template file](template.ansible-lint.yml) to your project following [the Using local configuration files - Configuration - Ansible Lint Documentation section](https://ansible.readthedocs.io/projects/lint/configuring/#using-local-configuration-files).

1. Customize the copy of the configuration file in your project to your liking.

## References

The following external materials are referenced during the development of this project:

* [Configuration - Ansible Lint Documentation](https://ansible.readthedocs.io/projects/lint/configuring/)  

  Explains the format of the Ansible-lint configuration file.

* [Profiles - Ansible Lint Documentation](https://ansible.readthedocs.io/projects/lint/profiles/)  

  Explains the concepts and details of each Ansible-lint profiles.

## Licensing

Unless otherwise noted(individual file's header/[REUSE.toml](REUSE.toml)), this product is licensed under [the 4.0 International version of the Creative Commons Attribution-ShareAlike license](https://creativecommons.org/licenses/by-sa/4.0/), or any of its more recent versions of your preference.

As an exception of the previous clause, this product can be licensed otherwise under [the 2.0 version of the Apache license](https://www.apache.org/licenses/LICENSE-2.0) _if_ it is used to instantiate/refactor a project based on it rather than using it in the making of another template project.  This allows relicensing the project assets to your liking in your non-template projects with only a conformance requirement of attributing this product somewhere in your project/product credits/acknowledgment/copyright notice documentation/user interface.

This work complies to [the REUSE Specification](https://reuse.software/spec/), refer the [REUSE - Make licensing easy for everyone](https://reuse.software/) website for info regarding the licensing of this product.