From 7b4c1027592e47eb7d80479477bbbc395f6610c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=8D=9A=E4=BB=81=28Buo-ren=20Lin=29?= Date: Wed, 28 Aug 2024 00:37:57 +0800 Subject: [PATCH] feat: Implement config template prototype MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: ๆž—ๅšไป(Buo-ren Lin) --- ...e-2.0-If-Not-Used-In-Template-Projects.txt | 17 +++++++++++++++ README.md | 7 +++++++ template.ansible-lint.yml | 21 +++++++++++++++++++ 3 files changed, 45 insertions(+) create mode 100644 LICENSES/LicenseRef-Apache-2.0-If-Not-Used-In-Template-Projects.txt create mode 100644 template.ansible-lint.yml diff --git a/LICENSES/LicenseRef-Apache-2.0-If-Not-Used-In-Template-Projects.txt b/LICENSES/LicenseRef-Apache-2.0-If-Not-Used-In-Template-Projects.txt new file mode 100644 index 0000000..b293d10 --- /dev/null +++ b/LICENSES/LicenseRef-Apache-2.0-If-Not-Used-In-Template-Projects.txt @@ -0,0 +1,17 @@ +# The Apache-2.0-If-Not-Used-In-Template-Projects pseudo license + +Assets that are declared as either licensed under [the 4.0 International +version of the Creative Commons Attribution-ShareAlike license](https://creativecommons.org/licenses/by-sa/4.0/) +or this pseudo license 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 +re-licensing the project assets to your liking in your non-template +projects with only a legal conformance requirement of attributing this +product somewhere in your project/product credits/acknowledgment/copyright +notice documentation/user interface. + +Note that some assets that are not declared using this pseudo license +may also allow re-licensing as the declared license does not impose such +restrictions in the first place, refer the individual license terms for +details. diff --git a/README.md b/README.md index aeea205..b07414e 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,13 @@ 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: diff --git a/template.ansible-lint.yml b/template.ansible-lint.yml new file mode 100644 index 0000000..b3b5894 --- /dev/null +++ b/template.ansible-lint.yml @@ -0,0 +1,21 @@ +# Ansible-lint configuration file +# +# References: +# +# * Configuration - Ansible Lint Documentation +# https://ansible.readthedocs.io/projects/lint/configuring/ +# +# Copyright 2024 The Common Ansible Project Template Contributors +# SPDX-License-Identifier: CC-BY-SA-4.0 OR LicenseRef-Apache-2.0-If-Not-Used-In-Template-Projects + +# Profiles - Ansible Lint Documentation +# https://ansible.readthedocs.io/projects/lint/profiles/ +profile: production + +exclude_paths: + # Implicit unless exclude_paths is defined in config + - .cache/ + + # Don't check external Ansible resources + - playbooks/roles/*/ + - playbooks/collections/*/