codex-agent-repository-kit/manifest.json

{
  "name": "codex-agent-repository-kit",
  "version": "1.0.6",
  "description": "Universal repository baseline for Codex-assisted projects.",
  "agentResponsibilities": [
    "Read manifest.json before copying files.",
    "Use copyMap target paths unless the repository already has an equivalent convention.",
    "Conserve context tokens by searching first, reading only relevant files, summarizing large outputs, and avoiding generated folders, dependency folders, build outputs, or full logs unless directly relevant.",
    "At the start of each user-requested task, check for upstream repository updates and apply them immediately with a safe fast-forward pull when the working tree is clean.",
    "Use only the configured Gitea Ubuntu runners global-runner-1, global-runner-2, and global-runner-3 for project builds, tests, audits, package jobs, installers, dependency setup, and releases.",
    "Never run heavy project commands on the user's local machine; keep local verification limited to lightweight checks that do not install dependencies or create build artifacts.",
    "Do not add Windows or macOS runners; use open-source Linux-compatible workarounds that run on ubuntu-latest, ubuntu-24.04, or ubuntu-22.04.",
    "Check git status before editing and before finishing.",
    "Preserve unrelated user changes.",
    "Replace applicable placeholders and remove non-applicable placeholder sections.",
    "Keep AGENTS.md and .codex/project.md aligned with real commands and artifact paths.",
    "Update README.md whenever blueprint.md or blueprint.json changes.",
    "Update docs/security-review.md during release-readiness work.",
    "Update docs/release-checklist.md when release behavior changes.",
    "Create focused tracker issues for real follow-up work that is outside the current scope or independently parallelizable, and use docs/agent-handoff.md when no issue tracker is available.",
    "Add or preserve non-destructive scheduled repository cleanup checks for active projects.",
    "Add or preserve dependency, release dry-run, and template compliance checks when they fit the project.",
    "Run git diff --check before finishing.",
    "Run lightweight local validation before finishing, then use Gitea Actions for project verification or document why runner verification could not run.",
    "After pushing workflow-triggering commits, poll Gitea workflow runs until success or a concrete blocker."
  ],
  "securityAutomation": {
    "workflow": "files/security-scan-gitea.yml",
    "target": ".gitea/workflows/security-scan.yml",
    "schedule": "weekly",
    "checks": [
      "stack-specific dependency audit",
      "suspicious code pattern scan",
      "secret and config leak scan",
      "AI instruction injection scan"
    ]
  },
  "cleanupAutomation": {
    "workflow": "files/repo-cleanup-gitea.yml",
    "target": ".gitea/workflows/repo-cleanup.yml",
    "schedule": "weekly",
    "checks": [
      "tracked generated files",
      "large tracked files",
      "secret-prone local config files",
      "stale branch candidates"
    ],
    "destructive": false
  },
  "dependencyAutomation": {
    "workflow": "files/dependency-check-gitea.yml",
    "target": ".gitea/workflows/dependency-check.yml",
    "schedule": "weekly",
    "checks": [
      "dependency vulnerability reports",
      "outdated dependency reports",
      "Docker base image references"
    ],
    "destructive": false
  },
  "releaseDryRunAutomation": {
    "workflow": "files/release-dry-run-gitea.yml",
    "target": ".gitea/workflows/release-dry-run.yml",
    "trigger": "push and manual",
    "checks": [
      "release documentation presence",
      "unresolved placeholder scan",
      "stack-specific build/test checks",
      "artifact discovery"
    ],
    "publishes": false
  },
  "templateComplianceAutomation": {
    "workflow": "files/template-compliance-gitea.yml",
    "target": ".gitea/workflows/template-compliance.yml",
    "trigger": "push, pull request, and manual",
    "checks": [
      "required Codex files",
      "unresolved placeholders",
      "README divider convention",
      "recommended workflow presence"
    ],
    "destructive": false
  },
  "readmeDivider": {
    "templateName": "section-line",
    "source": "https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png",
    "usage": "Keep {{ template:section-line }} between major sections in generated README files."
  },
  "workflows": {
    "newRepository": "new-repository.md",
    "existingProject": "existing-project.md",
    "quickstart": "agent-quickstart.md"
  },
  "schema": "manifest.schema.json",
  "copyMap": [
    {
      "source": "files/AGENTS.md",
      "target": "AGENTS.md",
      "required": true
    },
    {
      "source": "files/project.md",
      "target": ".codex/project.md",
      "required": true
    },
    {
      "source": "files/SECURITY.md",
      "target": "SECURITY.md",
      "required": false
    },
    {
      "source": "files/CHANGELOG.md",
      "target": "CHANGELOG.md",
      "required": false
    },
    {
      "source": "files/CONTRIBUTING.md",
      "target": "CONTRIBUTING.md",
      "required": false
    },
    {
      "source": "files/gitignore.template",
      "target": ".gitignore",
      "required": false
    },
    {
      "source": "files/agent-handoff.md",
      "target": "docs/agent-handoff.md",
      "required": false
    },
    {
      "source": "files/release-notes.md",
      "target": "docs/release-notes.md",
      "required": false
    },
    {
      "source": "files/release-checklist.md",
      "target": "docs/release-checklist.md",
      "required": false
    },
    {
      "source": "files/security-review.md",
      "target": "docs/security-review.md",
      "required": false
    },
    {
      "source": "files/blueprint.md",
      "target": "blueprint.md",
      "required": false
    },
    {
      "source": "files/blueprint.json",
      "target": "blueprint.json",
      "required": false
    },
    {
      "source": "files/build-gitea.yml",
      "target": ".gitea/workflows/build.yml",
      "required": false
    },
    {
      "source": "files/security-scan-gitea.yml",
      "target": ".gitea/workflows/security-scan.yml",
      "required": false
    },
    {
      "source": "files/repo-cleanup-gitea.yml",
      "target": ".gitea/workflows/repo-cleanup.yml",
      "required": false
    },
    {
      "source": "files/dependency-check-gitea.yml",
      "target": ".gitea/workflows/dependency-check.yml",
      "required": false
    },
    {
      "source": "files/release-dry-run-gitea.yml",
      "target": ".gitea/workflows/release-dry-run.yml",
      "required": false
    },
    {
      "source": "files/template-compliance-gitea.yml",
      "target": ".gitea/workflows/template-compliance.yml",
      "required": false
    }
  ],
  "placeholders": [
    "PROJECT_NAME",
    "PROJECT_DESCRIPTION",
    "REPOSITORY_OWNER",
    "REPOSITORY_NAME",
    "PACKAGE_NAME",
    "ARTIFACT_NAME",
    "ARTIFACT_OUTPUT_DIRECTORY",
    "AUTHOR_NAME",
    "PROJECT_STACK",
    "DOWNLOAD_URL",
    "CI_URL",
    "RELEASES_URL",
    "BUILD_COMMAND",
    "TEST_COMMAND",
    "LINT_COMMAND",
    "AUDIT_COMMAND",
    "README_COMMAND",
    "INSTALL_COMMAND",
    "DEV_COMMAND",
    "PACKAGE_MANAGER",
    "PROJECT_VERSION",
    "COMMIT_OR_VERSION"
  ],
  "profiles": [
    {
      "name": "node",
      "path": "profiles/node.md"
    },
    {
      "name": "electron",
      "path": "profiles/electron.md"
    },
    {
      "name": "python",
      "path": "profiles/python.md"
    },
    {
      "name": "docker",
      "path": "profiles/docker.md"
    },
    {
      "name": "static-site",
      "path": "profiles/static-site.md"
    }
  ]
}