This repository is a maintained fork of PaloAltoNetworks/docusaurus-openapi-docs.
mainis the only development and release source for this fork.- Upstream history is fetched from
PaloAltoNetworks/docusaurus-openapi-docsas theupstreamremote. - Shared
mainis never rebased onto upstream. Each accepted upstream tag is merged through a dedicatedsync/upstream-vX.Y.Zpull request.
- 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-themerelease boundary. - Root manifests,
yarn.lock, shared workflows, and top-level documentation require explicit reconciliation.
- Fetch upstream branches and tags.
- Create
sync/upstream-vX.Y.Zfrom currentorigin/main. - Verify the upstream repository and annotated release tag, then merge it with
--no-ff. - Resolve source conflicts according to ownership. Regenerate
yarn.lockfrom the combined manifests instead of choosing either side. - Run upstream tests plus the complete AEEI theme, docs-starter, package, and browser validation.
- Compare the packed
@aeei/docusaurus-themeartifact 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. - Merge only after independent review and green CI.
- Deck consumes a repository-owned tarball; npm is a secondary distribution channel.
- npm publication is manual through
.github/workflows/theme-release.ymland the protectedtheme-releaseenvironment. - npm trusted publishing must bind
@aeei/docusaurus-themeto repositoryaeei/docusaurus-theme, workflowtheme-release.yml, and environmenttheme-release. - A new publish requires
publish @aeei/docusaurus-theme@X.Y.Z. The privileged job atomically reserves or verifiestheme-vX.Y.Zfor the exact source SHA before npm publication, so a competing tag aborts before publish. If npm fails after reservation, retrypublishwith that original 40-character commit assource_sha. recover-tagis only for an npm version published outside this workflow without its source tag. It requires the originalsource_shaandrecover 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 npmdist.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.
- Last integrated upstream release:
v5.1.3 - Upstream baseline commit:
d5af4f22e951712e084df8b7c513a1708e56d372 - Current AEEI theme release:
0.1.10