ansible-galaxy-cookiecutter

Author: Jared Cook
Version: 0.1.1

Overview

Ansible Galaxy cookiecutter template + integration with Github docs template (github-docs-cookiecutter) generation.

Ansible Galaxy cookiecutter template project /w Ansible Auto Documentation + Github docs template generation + Sphinx docs template generation.

Utilizes:
The ansible-galaxy-cookiecutter depends on the following repositories for its documentation and sub-features.

• cookiecutter-cookiecutter Generates cookiecutter template projects and is able to be queried by generated projects for autogenerated file updates.
• Github docs cookiecutter template generation.
• Nutri-Matic cookiecutter utilities for streamlining development and utilization of Cookiecutter templates.

Maintains:
The ansible-galaxy-cookiecutter is used to maintain the build and ci/cd structure for the following projects.

• jcook3701.docker Ansible Galaxy collection used to install docker packages.
• jcook3701.flatpak Ansible Galaxy collection used to install flatpak packages.
• jcook3701.pkgs Ansible Galaxy collection used to install system (Debian, Ubuntu, RHEL) packages.
• jcook3701.source Ansible Galaxy collection used to install packages from source code.
• jcook3701.snap Ansible Galaxy collection used to install snap packages.

---

🛠️ CI/CD Check List:

• 
• 
• 
• 
• 
• 
• 

---

Note: Unless you are using a newer version of cookiecutter >= 2, --no-input is necessary for template generation without error.

Usage Examples

Example: Pull from main branch.
Note: Nutri-Matic is needed in active python environment.

$ cookiecutter git@github.com:jcook3701/ansible-galaxy-cookiecutter.git \
    --no-input \
    namespace="jcook3701" \
    project_name="test-project" \
    description="Ansible test project."

Example: Pull from develop branch.

$ cookiecutter git@github.com:jcook3701/ansible-galaxy-cookiecutter.git \
    --checkout develop \
     --no-input \
    namespace="jcook3701" \
    project_name="test-project" \
    description="Ansible test project."

Note: replace test-project or any of the other variables with real context configuration variables.

---

🌱 Getting Started

• Requirements
• Installation guide

📚 Documentation

The ansible-galaxy-cookiecutter documentation is available at docs.

🤝 Contributing

If you’re interested in contributing to the ansible-galaxy-cookiecutter project:

• Start by reading the contributing guide.
• Learn how to setup your local environment, in our developer guide.
• Look through our style guide.

---

🍹 Authors Notes

1. This code currently works with cookiecutter (V2.6) from PyPi’s repositories.

⚖️ License

Copyright (c) 2025-2026, Jared Cook

This project is licensed under the AGPL-3.0-or-later License.
See the LICENSE file for the full license text.

SPDX-License-Identifier: AGPL-3.0-or-later