23 lines
831 B
Markdown
23 lines
831 B
Markdown
|
CI Badge
|
||
|
|
|
||
|
|
# Ansible template role
|
||
|
|
Role that fulfills some need and there was not some sort of equivalent elsewhere.
|
||
|
|
|
||
|
|
## Getting started
|
||
|
|
Ensure all dependencies are installed/met and then do the following:
|
||
|
|
1. Get the development repository: `git clone repo`
|
||
|
|
2. Install pre-commit: `pre-commit install`
|
||
|
|
3. Make edits as required as well as following the customization section
|
||
|
|
4. Run `pre-commit` to ensure we're good
|
||
|
|
5. Do your necessary development work for this role
|
||
|
|
6. Run `pre-commit` again to ensure you're good to go.
|
||
|
|
|
||
|
|
## Dependencies
|
||
|
|
This repo expects 3 things installed on your local machine:
|
||
|
|
1. [pre-commit](https://pre-commit.com/)
|
||
|
|
2. [ansible-lint](https://github.com/ansible-community/ansible-lint)
|
||
|
|
3. [yamllint](https://github.com/adrienverge/yamllint)
|
||
|
|
|
||
|
|
## Changelog
|
||
|
|
The [changelog](./CHANGELOG.md) is stored externally
|