mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-09 12:17:13 +00:00
kevinveenbirkenbachandClaude Opus 5
7bc12e55f3
aceb5295efmoved Cosmos, Quick Setup and Credits out of the committed role READMEs and into the documentation build's own scratch checkout, so a committed copy can no longer go stale when the metadata moves. Merging feature/designer (ebad39422c) took origin/main's side of those files, which still carries them, and reinstated all 290 along with the cosmos make target and its i8cos alias. tests/lint/ansible/roles/test_readme.py hard-fails on a committed copy, and the reinstated Credits block credited one person with two URLs, which tripped the credits-attribution lint as well. Stripped with the repository's own fence-aware parser against MANAGED_SECTIONS, not with a line filter: the Cosmos block holds a mermaid fence a naive filter would cut through. The result is byte-identical toaceb5295effor every README that carries no prose change since. The cosmos target wrote the forbidden section straight back into the checkout, so it goes with them. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
# System Utility: Git Pull (Shallow & Pinned)
|
|
|
|
## Description
|
|
|
|
This Ansible role provides a **robust, reusable Git pull utility** for system automation.
|
|
It performs shallow clones or updates of Git repositories and optionally **pins the working tree
|
|
to a specific tag** (e.g. `stable`) in a detached HEAD state.
|
|
|
|
The role is designed to solve common automation pitfalls such as:
|
|
|
|
- conflicting local tags (`would clobber existing tag`)
|
|
- detached HEAD updates
|
|
- annotated vs. lightweight tags
|
|
- reliable change detection for Ansible
|
|
|
|
Internally, the role delegates complex Git logic to a small, well-tested Python helper script,
|
|
keeping the Ansible YAML concise and readable.
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
This role:
|
|
|
|
- Ensures a repository exists at a given destination
|
|
- Clones the repository shallowly if it does not exist
|
|
- Updates an existing repository in a **detached-safe** manner
|
|
- Optionally removes conflicting local tags before fetching
|
|
- Optionally pins the checkout to a specific tag (e.g. `stable`)
|
|
- Marks the Ansible task as `changed` if:
|
|
- the repository was cloned
|
|
- tags were removed
|
|
- the pinned tag appeared for the first time
|
|
- the pinned tag moved on the remote (optional)
|
|
|
|
---
|
|
|
|
## Purpose
|
|
|
|
The purpose of this role is to provide a **generic, reusable Git pull primitive**
|
|
for other roles in the Infinito.Nexus ecosystem.
|
|
|
|
Typical use cases include:
|
|
|
|
- installing tools pinned to a `stable` tag
|
|
- reproducible system deployments
|
|
- CI/CD-friendly shallow clones
|
|
- avoiding fragile inline Git shell logic in roles
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
- **Shallow Clone & Update** (`--depth`)
|
|
- **Detached-safe Branch Updates**
|
|
- **Optional Tag Pinning** (e.g. `stable`)
|
|
- **Annotated Tag Support** (`tag^{}`)
|
|
- **Local Tag Conflict Healing**
|
|
- **Deterministic `changed_when` Semantics**
|
|
- **Verbose Debug Logging (stderr-only)**
|
|
|
|
---
|
|
|
|
## Design Notes
|
|
|
|
- All human-readable logs go to **stderr**
|
|
- Machine-readable state (`CHANGED=…`) is written to **stdout**
|
|
- This guarantees reliable `changed_when` behavior in Ansible
|
|
- The Python helper is intentionally self-contained and unit-testable
|