0 Fork 0

mirror of https://github.com/cozystack/cozystack.git synced 2026-11-05 03:27:07 +09:00

Files

T

Aleksei Sviridkin d5ecac3fee docs(agents): retry CI via empty commit, not gh run rerun

Rerun attempts restart jobs under the same run_id and do not re-register
into the workflow's concurrency group. When a real fix-commit lands
while a rerun is in flight, cancel-in-progress cannot gate the old
rerun, so two runs race to completion and operators pay CI twice.

Push an empty commit (`git commit --allow-empty`) instead — it
participates in the concurrency group cleanly and the next real push
cancels it as expected. Add the guidance to docs/agents/contributing.md
and wire a trigger in AGENTS.md so any agent asked to "rerun CI" or
"retry the failed build" reaches for the empty commit first.

Assisted-By: Claude <noreply@anthropic.com>
Signed-off-by: Aleksei Sviridkin <f@lex.la>

2026-04-24 14:07:16 +03:00

3.6 KiB

Raw Permalink Blame History

AI Agents Overview

This file provides structured guidance for AI coding assistants and agents working with the Cozystack project.

Activation

CRITICAL: When the user asks you to do something that matches the scope of a documented process, you MUST read the corresponding documentation file and follow the instructions exactly as written.

Commits, PRs, git operations (e.g., "create a commit", "make a PR", "fix review comments", "rebase", "cherry-pick")
- Read: contributing.md
- Action: Read the entire file and follow ALL instructions step-by-step
Changelog generation (e.g., "generate changelog", "create changelog", "prepare changelog for version X")
- Read: changelog.md
- Action: Read the entire file and follow ALL steps in the checklist. Do NOT skip any mandatory steps
Release creation (e.g., "create release", "prepare release", "tag release", "make a release")
- Read: releasing.md
- Action: Read the file and follow the referenced release process in docs/release.md
Project structure, conventions, code layout (e.g., "where should I put X", "what's the convention for Y", "how is the project organized")
- Read: overview.md
- Action: Read relevant sections to understand project structure and conventions
Retrying CI after a flake (e.g., "rerun CI", "retry the failed run", "the build flaked, kick it again")
- Read: contributing.md, section "Retrying a CI run after a flake"
- Action: Push an empty commit with git commit --allow-empty. Do NOT use gh run rerun — it bypasses the concurrency group and leaves duplicate runs in flight
General questions about contributing
- Read: contributing.md
- Action: Read the file to understand git workflow, commit format, PR process

Important rules:

✅ ONLY read the file if the task matches the documented process scope - do not read files for tasks that don't match their purpose
✅ ALWAYS read the file FIRST before starting the task (when applicable)
✅ Follow instructions EXACTLY as written in the documentation
✅ Do NOT skip mandatory steps (especially in changelog.md)
✅ Do NOT assume you know the process - always check the documentation when the task matches
❌ Do NOT read files for tasks that are outside their documented scope
📖 Note: overview.md can be useful as a reference to understand project structure and conventions, even when not explicitly required by the task

Project Overview

Cozystack is a Kubernetes-based platform for building cloud infrastructure with managed services (databases, VMs, K8s clusters), multi-tenancy, and GitOps delivery.

Quick Reference

Code Structure

packages/core/ - Core platform charts (installer, platform)
packages/system/ - System components (CSI, CNI, operators)
packages/apps/ - User-facing applications in catalog
packages/extra/ - Tenant-specific modules
cmd/, internal/, pkg/ - Go code
api/ - Kubernetes CRDs

Conventions

Helm Charts: Umbrella pattern, vendored upstream charts in charts/
Go Code: Controller-runtime patterns, kubebuilder style
Git Commits: Conventional Commits (type(scope): description) with --signoff

What NOT to Do

❌ Edit /vendor/, zz_generated.*.go, upstream charts directly
❌ Modify go.mod/go.sum manually (use go get)
❌ Force push to main/master
❌ Commit built artifacts from _out

3.6 KiB Raw Permalink Blame History