Skip to content

Commit

Permalink
feat: Implement config template prototype
Browse files Browse the repository at this point in the history
Signed-off-by: 林博仁(Buo-ren Lin) <[email protected]>
  • Loading branch information
brlin-tw committed Aug 27, 2024
1 parent 842292b commit 7b4c102
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ Ready-to-use Ansible-lint configuration file at your fingertips!
<https://gitlab.com/the-common/ansible-lint-configuration-template>
[![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:
Expand Down
21 changes: 21 additions & 0 deletions template.ansible-lint.yml
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/the-common/ansible-project-template/graphs/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/*/

0 comments on commit 7b4c102

Please sign in to comment.