Skip to content

Update an existing APEX project

An existing project can differ from both APEX main and the current Accelerator template. Check your repository before applying new instructions. Updating customizations does not authorize a deployment or make earlier approval valid for changed inputs.

This guidance was source-reviewed on 2026-09-24 against APEX fb65b780c995 and Accelerator a77442889129.

The generated Architecture Explorer uses fb65b780c995. It matches the recorded guidance baseline.

A source review checks instructions against repository contracts. It does not mean that every command, client configuration or Azure operation was executed. An execution-tested claim needs its own recorded environment, inputs and result. The site’s build date and page modification dates are not execution evidence.

The dated case study and preserved downloads are historical material, not compatibility promises. The footer links here and identifies the guidance baseline separately from the documentation build.

Run these read-only commands in your template-derived repository:

Terminal window
git status --short
git rev-parse HEAD
git log -5 --oneline -- .github/agents .github/skills .devcontainer .vscode

The first command shows local changes; the second identifies your project commit. That commit is not necessarily an APEX release or upstream revision. Use the merged sync PR and its source comparison to identify which upstream changes your repository received. If that history is unavailable, compare the relevant files directly rather than assuming your project matches current main.

Before updating, preserve your work through your normal reviewed Git process. Do not include secrets, local credentials or raw diagnostic logs in a commit. Resolve local changes before applying an upstream update.

Review the sync mechanism in your repository

Section titled “Review the sync mechanism in your repository”

The reviewed template’s Upstream Sync workflow proposes scheduled updates through a PR. Manual runs default to a dry run. It does not automatically merge them.

Read the workflow in your own repository first. It may have changed since you created the project, and a template-derived repository is not continuously identical to its template.

At the reviewed baseline, the sync mirrors upstream files except for declared exclusions, exceptions and seed rules:

ContentWhat to review
Agents, skills, instructions, prompts, hooks and container/editor configurationUpstream can replace these files. Preserve intentional local changes explicitly.
agent-output/, generated infra/bicep/ and infra/terraform/These are excluded, but shared infra/*/AGENTS.md files are explicit sync exceptions.
Root AGENTS.md and shared repository configurationDo not assume these are protected just because generated workload files are excluded.
.github/workflows/These are handled separately. Review workflow changes and permissions before intentionally using npm run sync:workflows.
Private data and locally seeded indexesRead the actual exclusion and seed lists. Do not copy private data into an upstream contribution.

Do not replace this review with a bulk copy of APEX main or a destructive Git reset. A dry run helps inspect the proposed update; it is not proof that the result preserves every local customization.

Read the diff for changes to:

  • Main-agent names, permitted helpers, review defaults and handoff artifacts.
  • State schemas and recovery commands.
  • Security defaults, governance evidence, SKU decisions and validation freshness.
  • Container dependencies, lifecycle scripts, MCP configuration and authentication.
  • Workflow permissions and repository initialization behavior.

Compare these with the workflow overview and your project’s current requirements. If a documented agent, command or artifact is missing, establish the version difference first. Do not invent a substitute or skip a gate.

The docs repository’s source-update PR includes a path-based impact report. It suggests pages to review; it cannot decide whether the behavioral change is safe for your workload or whether the prose is correct.

After accepting an update, follow the changed setup instructions in your own repository. Rebuild the development container when its configuration or tooling requires it, and check the setup output. Do not rerun initialization or cloud setup merely because a dependency changed.

Select 01-Orchestrator with the existing project, the accepted update and the last completed step. Ask it to identify the correct owner and missing evidence before continuing. Use session debugging if the recorded state cannot be read. Do not edit state to force progress.

APEX’s Deploy agent owns deployment. Changed code, scope, policy evidence or preview results may require fresh validation and approval. An accepted sync PR is not authorization to apply infrastructure changes. See Step 6: Deploy for the agent’s responsibilities.