Skip to content

CLAUDE.md

Latest commit

 

History

History
41 lines (25 loc) · 2.45 KB

CLAUDE.md

File metadata and controls

41 lines (25 loc) · 2.45 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What this repo is

A collection of reusable go-task include files. Each file in src/ is published as a standalone module that downstream projects consume remotely via Taskfile's remote-taskfiles experiment (see the TASK_COLLECTION_BASE URL pattern in README.md). There is no build artifact — the YAML files themselves are the product.

Module conventions

Every include file in src/ follows the same contract; preserve it when editing or adding modules:

  • Filename is taskfile-include-<area>.yaml. The <area> is what consumers use as the includes: key.
  • Every task sets dir: '{{.USER_WORKING_DIR}}' so commands run in the consumer's working directory, not this repo. Do not drop this.
  • Python-backed tasks (mkdocs, pre-commit) activate pre-provisioned venvs at ~/.venvs/docs and ~/.venvs/development rather than installing dependencies themselves — the consumer's machine is expected to have them (these venvs are provisioned by nolte/workstation).
  • Tunable behavior is exposed via vars: with sensible defaults (e.g., KIND_CREATE_EXTRA_ARGS, ARGOCD_EXTRA_ARGS, MKDOCS_PORT) so consumers can override without forking.

Common commands

# List tasks wired into the local Taskfile
task

# Serve the mkdocs site locally (requires ~/.venvs/docs)
task mkdocs:start

# Run all pre-commit hooks against the repo (requires ~/.venvs/development)
pre-commit run --all-files

requirements-dev.txt pins the mkdocs stack; install it into ~/.venvs/docs if the venv does not already exist.

Docs pipeline

docs/index.md pulls content from README.md between the <!--intro-start-->/<!--intro-end--> and <!--usage-start-->/<!--usage-end--> markers via mkdocs-include-markdown-plugin. When editing README sections that sit between those markers, verify the rendered docs still make sense — the markers are the integration point, do not remove them.

CI

All workflows in .github/workflows/ delegate to reusable workflows in nolte/gh-plumbing (pre-commit, trivy, chain-bench, mkdocs publish, release-drafter). Pinning is by tag (currently v1.1.10); bump all workflow references together.

Prose in Markdown is linted with Vale using the config in .vale.ini (Microsoft + RedHat + nolte custom styles).