Glossary

Auto-generated 2026-07-03 by scripts/generate-book-pages.py

Definitions for every term, acronym, and concept used across fork-sync-all.


Index

A: ACTOR_TZ · AGENTS.md · autonomous mode
B: book-engine · brand.yml · budget.sh
C: chain position · consumer repo · critical-deploy
D: DRY_RUN
E: Etc/GMT+N
F: FSA API · fsa-mode.sh · fsa-node-identity.sh · full-chain-flush
G: generate-book-pages.py · gh-api.sh · GitLab subgroup · GraphQL · GROUP_SORT_KEYS
I: IANA timezone · infra-core profile
M: managed mode · MCP server · mdBook · MIN_QUOTA · mirror chain
N: node identity
O: OOC · OSP · OSP-bound repo · OTA
P: platform-adapter.sh · pre-flush-prep · priority tiers
Q: queue-manager · quota-reserve · quota-snapshot.sh
R: registered-imports.json
S: SUMMARY.md · SYNC_TOKEN
T: template-manifest.yml · time_format.py
V: vendor/
W: workflow-quota-costs.yml · WORLD_ZONES


ACTOR_TZ
IANA timezone of the person who triggered a workflow. Set via `ACTOR_TZ`, `TRIGGERER_TZ`, or `GITHUB_ACTOR_TZ` env vars. Highlighted in world_table() output.
AGENTS.md
Convention file for AI agents working in this repo. Defines logging rules, YAML-safe shell patterns, quota management, workflow patterns, and known pitfalls.
autonomous mode
Operating mode when fork-sync-all is not present alongside a consumer repo. Bundled workflows activate and self-manage, scoped to the repo's own owner.
book-engine
Agnostic documentation export backend in `vendor/book-engine/`. Supports mdBook, MkDocs, Docusaurus, GitBook CLI, and Pandoc from a single Markdown source.
brand.yml
Single source of truth for fork-sync-all branding: logo URL, color palette, substitution tokens (`{{FSA_NAME}}` etc.), and book theme settings.
budget.sh
Shared include providing `budget_init`, `budget_check`, `budget_report`, `osp_priority_repos`, and `workflow_min_quota`. Reads per-workflow `min_quota` from `workflow-quota-costs.yml`.
chain position
Where a fork-sync-all instance sits in the mirror chain: `source` (Interested-Deving-1896), `mirror` (OSP/OOC), or `downstream-fork` (independent fork).
consumer repo
Any repo that receives template files from fork-sync-all via `sync-template.sh`. Defined in `config/template-consumers.yml`.
critical-deploy
Fast-lane workflow for emergency deployments: commit + push → aggressive queue clear → priority dispatch. Manual trigger only.
DRY_RUN
Environment variable flag. When `true`, scripts print what they would do without making any changes. Supported by all major scripts.
Etc/GMT+N
IANA timezone notation where the sign is inverted from UTC offset convention. `Etc/GMT+5` = UTC-5 (EST). All 484 IANA zones are included in `time_format.py`.
FSA API
The `ona-mcp-server.py` MCP server exposing 5 tools: `list_projects`, `get_project`, `create_environment`, `sync_projects`, `get_config_summary`. Runs on port 8788.
fsa-mode.sh
Three-tier managed/autonomous detection: (B) `FSA_MANAGED` repo variable → (A) GET `/repos/{owner}/fork-sync-all` → (C) token owner's fork-sync-all existence.
fsa-node-identity.sh
Extends fsa-mode.sh with chain position detection. Exports `FSA_NODE_POSITION`, `FSA_NODE_OWNER`, `FSA_UPSTREAM_OWNER`, `FSA_CHAIN_DEPTH`.
full-chain-flush
End-to-end pipeline: pre-flush-prep → mirror chain → post-flush-prep. Triggered manually or by critical-deploy.
generate-book-pages.py
Script that generates `DOCS/generated/` pages from live config sources. Also injects index + glossary into workflow-triggers.md.
gh-api.sh
Shared include providing `gh_api`, `gh_get`, `gh_api_graphql`, `merge_upstream`, `get_default_sha`. All status messages use `>&2`.
GitLab subgroup
Organizational unit in the `openos-project` GitLab group. Defined in `config/gitlab-subgroups.yml`. 14 subgroups covering ~225 repos.
GraphQL
Preferred over paginated REST for any loop fetching the same data for multiple repos. Counts as 1 REST call regardless of how many repos are queried.
GROUP_SORT_KEYS
Dict in `generate-workflow-triggers-doc.py` mapping group names to filename-substring lists for non-alphabetical display ordering.
IANA timezone
Standard timezone identifier from the IANA Time Zone Database (e.g. `America/Toronto`, `Europe/Paris`). `time_format.py` covers all 484 zones.
infra-core profile
Template profile providing CI hygiene + autonomous-fallback workflows. Includes PR automation, token rotation, branch cleanup, mdBook workflows, OTA, accessibility.
managed mode
Default operating mode when fork-sync-all is present. Bundled autonomous-fallback workflows detect this and skip themselves.
MCP server
Model Context Protocol server. `ona-mcp-server.py` exposes FSA operations as MCP tools consumable by any MCP-compatible AI agent.
mdBook
Rust-based static site generator used as the primary book engine. Source in `DOCS/`, config in `book.toml`, deployed to GitHub Pages by `deploy-book.yml`.
MIN_QUOTA
Minimum remaining REST quota required before a workflow proceeds. Set per-workflow in `config/workflow-quota-costs.yml`. Typically 500–1500.
mirror chain
Three-org pipeline: Interested-Deving-1896 → OpenOS-Project-OSP (GitHub) → openos-project (GitLab). Managed by mirror-to-osp.yml, mirror-osp-to-gitlab.yml.
node identity
The position of a fork-sync-all instance in the mirror chain. See `fsa-node-identity.sh`. Determines which operations the instance runs.
OOC
OpenOS-Project-Ecosystem-OOC — the third org in the mirror chain (GitHub). Receives mirrors from OSP.
OSP
OpenOS-Project-OSP — the second org in the mirror chain (GitHub). Receives mirrors from Interested-Deving-1896.
OSP-bound repo
A repo in Interested-Deving-1896 that is mirrored into OSP and managed by fork-sync-all (README updates, badge injection, CI checks, etc.).
OTA
Over-the-air update system. Delivers workflow and config updates from fork-sync-all to consumer repos without requiring manual PRs.
platform-adapter.sh
Uniform interface for GitHub, GitLab, Gitea, Forgejo, and Codeberg. Abstracts API differences behind a common shell interface.
pre-flush-prep
Pre-flight workflow run before full-chain-flush. Checks quota, validates configs, merges pending PRs, cleans stale branches.
priority tiers
Four-tier workflow priority system: Tier 1 CRITICAL (never cancelled), Tier 2 HIGH (mirror/sync), Tier 3 MEDIUM (READMEs/CI), Tier 4 LOW (translation/maintenance).
queue-manager
Workflow that deduplicates queued runs (keeps newest per workflow) and evicts runs queued > 25 min. Runs every 30 min.
quota-reserve
Workflow that cancels low-priority queued runs when quota drops below 1000. Uses per-workflow `min_quota` for cost-aware cancellation.
quota-snapshot.sh
Shared include that captures a REST quota snapshot and writes it to a GitHub Actions variable. Must run after `actions/checkout`.
registered-imports.json
Registry of upstream repos to keep in sync. Read by `sync-registered-imports.sh` and `sync-registry-sources.yml`.
SUMMARY.md
mdBook navigation file. Defines the book's table of contents. All book-engine adapters translate this into their native nav format.
SYNC_TOKEN
GitHub token used for cross-org operations. Shares the same 5000 req/hr REST bucket as `GH_TOKEN` (same user ID 202036334).
template-manifest.yml
Defines 6 named propagation profiles (full, mirror, infra-core, upstream-sync, standalone, shell-tools) and their file inclusion lists.
time_format.py
Shared Python module providing dual 12h/24h format across all 484 IANA timezones. Includes actor/runner timezone detection and `--test` self-test.
vendor/
Third-party components hosted/deployed by fork-sync-all. Not first-party scripts. Contains infra-dashboard, shell-tools, unified-agnostic-api, book-engine.
workflow-quota-costs.yml
Per-workflow REST call cost registry. Drives quota-reserve.sh cancellation, budget.sh pre-flight, and DOCS/quota-costs.md documentation.
WORLD_ZONES
Dynamic list of all 484 IANA timezone zones in `time_format.py`. Built at import time from `zoneinfo.available_timezones()`, sorted west→east.