diff options
| l--------- | .github/copilot-instructions.md | 1 | ||||
| -rw-r--r-- | AGENTS.md | 48 |
2 files changed, 49 insertions, 0 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 120000 index 0000000..be77ac8 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1 @@ +../AGENTS.md
\ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..72ccfeb --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,48 @@ +# AGENTS.md + +## Project purpose + +VyOS fork of Debian's `live-boot` — the initramfs/boot scripts that bring up a Debian Live system. The VyOS extensions mount the VyOS config directories during system startup (see `components/9990-vyos.sh`). Required for the entire VyOS image to boot, even on 1.4. Ships Debian packages `live-boot`, `live-boot-doc`, `live-boot-initramfs-tools`. + +## Tech stack + +- POSIX shell + Roff manpages. +- Plain `Makefile` (no autotools). +- Debian packaging in `debian/`. + +## Build / test / run + +```sh +make # default target builds + lints scripts +make test # syntax check across backend/frontend/components scripts +dpkg-buildpackage -us -uc +``` + +`SCRIPTS = backend/*/* frontend/* components/*`. The `Makefile` enforces shell syntax via `sh -n` per script. + +## Repository layout + +- `backend/` — initramfs-tools and similar backend integration. +- `frontend/` — user-facing helpers. +- `components/` — boot-time hooks; `9990-vyos.sh` is the VyOS hook for config mount. +- `manpages/` — Roff manpages with i18n PO files under `manpages/po/`. +- `debian/` — packaging. + +## Cross-repo context + +Pre-dep of the live ISO. Consumed by `vyos/vyos-live-build` (the `live-build` fork) which is in turn consumed by `vyos/vyos-build` for ISO assembly. Listed in `VyOS-Networks/vyos-build-packages/repos.toml`. README explicitly notes the long-term goal of dropping this fork in favour of upstream Debian `live-build` plus added files in the `vyos-build` chroot. + +## Conventions + +- Default branch `current`. LTS branches `sagitta`/`circinus`/`equuleus` for backports. +- Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev) — enforced via `vyos/.github` reusables (see workflows below). +- Active workflows: `cla-check.yml`, `pr-mirror-repo-sync.yml`, `trigger-rebuild-repo-package.yml`. So this repo IS wired into the mirror pipeline (sends PRs to `VyOS-Networks/live-boot`) and the rebuild-dispatch chain (notifies `vyos-build-packages` to rebuild on merge). + +## Mirror relationship + +Mirror twin: `VyOS-Networks/live-boot`. Canonical side is here. Mirror pipeline is **active** — merges to `current` propagate via `pr-mirror-repo-sync.yml`. + +## Notes for future contributors + +- Long-term plan (per README): retire this fork. Don't add features here that could equally live in `vyos-build`'s chroot overlay. +- Any change touching `components/9990-vyos.sh` affects boot-time config mount on every VyOS install — coordinate with `vyos-1x` config-loading code. |