Skip to content
Masked-Kunsiquat edited this page Feb 18, 2025 · 4 revisions

πŸ› οΈ Ansible Repo Wiki

Welcome to the Ansible Monorepo Wiki! This wiki serves as a central knowledge base for managing, contributing to, and using the repository.


πŸ“Œ Overview

This repository contains modular Ansible playbooks and roles to automate infrastructure deployment and management.

  • Idempotency: Playbooks can run multiple times without side effects.
  • Security: Uses 1Password CLI for secrets management.
  • Standardization: Follows structured coding conventions.

πŸ“‚ Repository Structure

Section Description
README.md Main documentation for the repo
CODE_STANDARDS.md Coding guidelines and best practices
CONTRIBUTING.md How to contribute, PR guidelines
CHANGELOG.md Version history of changes

πŸš€ Getting Started

Prerequisites

  • Install Ansible:
    sudo apt install ansible
    
  • Install 1Password CLI for secrets:
    brew install 1password-cli  # macOS
    sudo apt install 1password-cli  # Linux

Clone the Repository

git clone https://github.com/Masked-Kunsiquat/ansible-prime.git
cd ansible-monorepo

πŸ› οΈ Contribution Guidelines

πŸ“– Before contributing, please read:

To submit a Pull Request (PR):

  1. Fork the repository.

  2. Create a new feature branch:

    git checkout -b feature/my-new-feature
  3. Follow commit message guidelines.

  4. Submit a well-documented PR.

πŸ”„ CI/CD & Testing

  • Lint before committing:

    ansible-lint playbooks/*.yml
  • GitHub Actions CI/CD ensures all PRs meet quality standards before merging.

  • Pre-commit hooks are enforced for YAML and Ansible linting.

πŸ“Œ Versioning & Release Process

  • All changes are tracked in CHANGELOG.md.
  • Releases follow semantic versioning (vX.Y.Z).
  • Run npx semantic-release to generate a new release.

πŸ“œ License

This project is licensed under the MIT License.

πŸ”₯ Need Help? Join the discussions!

πŸ‘‰ Open an Issue if you have questions or suggestions.