Docs: prototype generated plugin SDK reference (#51877)

* Chore: unblock synced main checks

* Docs: add plugin SDK docs implementation plan

* Docs: scaffold plugin SDK reference phase 1

* Docs: mark plugin SDK reference surfaces unstable

* Docs: prototype generated plugin SDK reference

* docs(plugin-sdk): replace generated reference with api baseline

* docs(plugin-sdk): drop generated reference plan

* docs(plugin-sdk): align api baseline flow with config docs

---------

Co-authored-by: Onur <2453968+osolmaz@users.noreply.github.com>
Co-authored-by: Vincent Koc <vincentkoc@ieee.org>
This commit is contained in:
Bob
2026-03-22 17:19:00 +01:00
committed by GitHub
parent 0f2c380bd9
commit 4f1e12a2b1
10 changed files with 6310 additions and 5 deletions

View File

@@ -379,6 +379,11 @@ jobs:
continue-on-error: true
run: pnpm config:docs:check
- name: Check plugin SDK API baseline drift
id: plugin_sdk_api_drift
continue-on-error: true
run: pnpm plugin-sdk:api:check
- name: Upload gateway watch regression artifacts
if: always()
uses: actions/upload-artifact@v7
@@ -397,6 +402,7 @@ jobs:
NO_RAW_WINDOW_OPEN_OUTCOME: ${{ steps.no_raw_window_open.outcome }}
GATEWAY_WATCH_REGRESSION_OUTCOME: ${{ steps.gateway_watch_regression.outcome }}
CONFIG_DOCS_DRIFT_OUTCOME: ${{ steps.config_docs_drift.outcome }}
PLUGIN_SDK_API_DRIFT_OUTCOME: ${{ steps.plugin_sdk_api_drift.outcome }}
run: |
failures=0
for result in \
@@ -406,7 +412,8 @@ jobs:
"extension-plugin-sdk-internal-boundary|$EXTENSION_PLUGIN_SDK_INTERNAL_BOUNDARY_OUTCOME" \
"lint:ui:no-raw-window-open|$NO_RAW_WINDOW_OPEN_OUTCOME" \
"gateway-watch-regression|$GATEWAY_WATCH_REGRESSION_OUTCOME" \
"config-docs-drift|$CONFIG_DOCS_DRIFT_OUTCOME"; do
"config-docs-drift|$CONFIG_DOCS_DRIFT_OUTCOME" \
"plugin-sdk-api-drift|$PLUGIN_SDK_API_DRIFT_OUTCOME"; do
name="${result%%|*}"
outcome="${result#*|}"
if [ "$outcome" != "success" ]; then

View File

@@ -72,7 +72,7 @@ jobs:
- name: Disallow direct inputs interpolation in composite run blocks
run: python3 scripts/check-composite-action-input-interpolation.py
config-docs-drift:
generated-doc-baselines:
if: github.event_name == 'workflow_dispatch'
runs-on: blacksmith-16vcpu-ubuntu-2404
steps:
@@ -87,3 +87,6 @@ jobs:
- name: Check config docs drift statefile
run: pnpm config:docs:check
- name: Check plugin SDK API baseline drift
run: pnpm plugin-sdk:api:check