From 9b56e72c9dc379fdd709a6524007aadf6f8179e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20Hern=C3=A1ndez?= Date: Thu, 25 Jun 2026 11:50:31 +0200 Subject: [PATCH] docs: add AGENTS.md and CLAUDE.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit AGENTS.md is the canonical guidance file for AI agents working in this repository — covering architecture constraints, conventions, and rules. CLAUDE.md contains only `@AGENTS.md`, making Claude Code load this file automatically alongside other AI tools. Assisted-by: ClaudeCode:claude-sonnet-4-6 Signed-off-by: Alex Hernández --- AGENTS.md | 23 +++++++++++++++++++++++ CLAUDE.md | 1 + 2 files changed, 24 insertions(+) create mode 100644 AGENTS.md create mode 100644 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..bcbf6ed --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,23 @@ +# document-server-package — Euro-Office Distribution & Packaging + +@../AGENTS.md + +Guidance for Claude Code (and other AI agents) working in **document-server-package** — multi-platform release installer generation. + +## What this repo is +A release-only repository housing build scripts, definitions, and compilation workflows for producing DEB, RPM, Windows EXE (Inno Setup), and static TAR archives. + +## M4 Macro Architecture & Bundled Dependencies +- **M4 Macro Templating:** Branding strings, corporate identities, and file system installation paths are dynamically injected via M4 macro placeholders expanded at compile time. + - **CRITICAL:** Do NOT hardcode `euro-office` or any explicit paths. Use M4 macros mapped directly to the DocumentServer `build/docker-bake.hcl` configuration. +- **Windows Dependency Bundling:** The Inno Setup configuration (`exe/*.iss`) pins and auto-downloads prerequisite binaries (PostgreSQL, Redis, RabbitMQ, Erlang, OpenSSL). + - **CRITICAL FAIL MODE:** Upgrading a dependency version requires updating its binary download URL AND calculating its new SHA checksum. Failing to update hashes breaks the offline installation verification pass. +- **Systemd Definitions:** Linux services (`ds-docservice`, `ds-converter`, `ds-metrics`) live as templated components in `common/` and must pass M4 validation. + +## Rules +- **Never** commit distribution artifacts (`*.deb`, `*.rpm`, `*.exe`, `*.tar.gz`) to this repository; they are strictly CI/CD output assets. +- **Never** modify bundled Windows binaries without validating network reachability of the download endpoint and cross-checking the installer compilation logs. +- **Never** perform daily logic development here. This repository is strictly for distribution and packaging engineering during release cycles. + +## Findings & Long-tail +No centralized findings store exists in this repository yet. Document edge cases in code comments or GitHub issues until one is established. \ No newline at end of file diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..43c994c --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md