Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 2.94 KB

File metadata and controls

40 lines (29 loc) · 2.94 KB

Upstream synchronization

This repository is a maintained fork of PaloAltoNetworks/docusaurus-openapi-docs.

Canonical branches

  • main is the only development and release source for this fork.
  • Upstream history is fetched from PaloAltoNetworks/docusaurus-openapi-docs as the upstream remote.
  • Shared main is never rebased onto upstream. Each accepted upstream tag is merged through a dedicated sync/upstream-vX.Y.Z pull request.

Ownership

  • Upstream owns the original OpenAPI plugin, schema renderer, demo, and their package versions.
  • AEEI owns packages/docusaurus-theme/, examples/docs-starter/, Base Nova audits, visual tests, legal notices, and the @aeei/docusaurus-theme release boundary.
  • Root manifests, yarn.lock, shared workflows, and top-level documentation require explicit reconciliation.

Sync procedure

  1. Fetch upstream branches and tags.
  2. Create sync/upstream-vX.Y.Z from current origin/main.
  3. Verify the upstream repository and annotated release tag, then merge it with --no-ff.
  4. Resolve source conflicts according to ownership. Regenerate yarn.lock from the combined manifests instead of choosing either side.
  5. Run upstream tests plus the complete AEEI theme, docs-starter, package, and browser validation.
  6. Compare the packed @aeei/docusaurus-theme artifact with the current release. If its bytes change, bump the package version and update every vendored consumer artifact; never reuse a version for a different archive.
  7. Merge only after independent review and green CI.

Theme release

  • Deck consumes a repository-owned tarball; npm is a secondary distribution channel.
  • npm publication is manual through .github/workflows/theme-release.yml and the protected theme-release environment.
  • npm trusted publishing must bind @aeei/docusaurus-theme to repository aeei/docusaurus-theme, workflow theme-release.yml, and environment theme-release.
  • A new publish requires publish @aeei/docusaurus-theme@X.Y.Z. The privileged job atomically reserves or verifies theme-vX.Y.Z for the exact source SHA before npm publication, so a competing tag aborts before publish. If npm fails after reservation, retry publish with that original 40-character commit as source_sha.
  • recover-tag is only for an npm version published outside this workflow without its source tag. It requires the original source_sha and recover theme-vX.Y.Z for @aeei/docusaurus-theme@X.Y.Z; recovery checks out that exact main ancestor and creates a tag only when its clean rebuild exactly matches npm dist.integrity.
  • The privileged release job receives only the prebuilt tarball, verifies its SHA-512 integrity and source tag, publishes only that file when needed, then verifies registry integrity.

Baseline

  • Last integrated upstream release: v5.1.3
  • Upstream baseline commit: d5af4f22e951712e084df8b7c513a1708e56d372
  • Current AEEI theme release: 0.1.10