stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 2 Releases Wiki Activity
Files
c34fb7256d021860877dcf718ab7352fc171d441
git.stella-ops.org/src/Sdk/StellaOps.Sdk.Generator/postprocess/README.md
StellaOps Bot 7c39058386
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
Details
AOC Guard CI / aoc-guard (push) Has been cancelled
Details
AOC Guard CI / aoc-verify (push) Has been cancelled
Details
Export Center CI / export-ci (push) Has been cancelled
Details
Symbols Server CI / symbols-smoke (push) Has been cancelled
Details
devportal-offline / build-offline (push) Has been cancelled
Details
up
2025-11-24 20:57:49 +02:00

2.7 KiB
Raw Blame History

Post-process Scaffold (SDKGEN-62-002)

These hooks are invoked via OpenAPI Generator's --enable-post-process-file option. They stay deterministic and offline-friendly:

  • Normalise line endings to LF and strip trailing whitespace.
  • Preserve file mode 0644.
  • Inject a deterministic banner for supported languages (TS/JS/Go/Java/C#/Python/Ruby) when enabled (default on).
  • Copy shared SDK helpers (auth, retries, pagination, telemetry) per language into the generated output when STELLA_POSTPROCESS_ROOT and STELLA_POSTPROCESS_LANG are provided. TypeScript/Python exports are auto-wired so helpers are available from the package barrel.

Usage

Set the generator's post-process command to this script (example for Bash):

export STELLA_SDK_POSTPROCESS="$PWD/postprocess/postprocess.sh"
export JAVA_OPTS="${JAVA_OPTS} -Dorg.openapitools.codegen.utils.postProcessFile=$STELLA_SDK_POSTPROCESS"

Or pass via CLI where supported:

--global-property "postProcessFile=$PWD/postprocess/postprocess.sh"

To copy shared helpers during post-processing, also set the generation root and language:

export STELLA_POSTPROCESS_ROOT="/path/to/generated/sdk"
export STELLA_POSTPROCESS_LANG="ts"   # ts|python|go|java|csharp|ruby

Determinism

  • Uses only POSIX tools (sed, perl) available in build containers.
  • Does not reorder content; only whitespace/line-ending normalization.
  • Safe to run multiple times (idempotent).

Configuration (optional)

  • STELLA_POSTPROCESS_ADD_BANNER (default 1): injects Generated by StellaOps SDK generator — do not edit. at the top of supported source files, idempotently.
  • STELLA_POSTPROCESS_ROOT: root directory of the generated SDK; required to copy helper files.
  • STELLA_POSTPROCESS_LANG: one of ts|python|go|java|csharp|ruby; controls which helper set is copied.

Helper contents (per language)

  • TypeScript (templates/typescript/sdk-hooks.ts, sdk-error.ts, package/tsconfig templates, README): fetch composers for auth, retries, telemetry headers, paginator, and a minimal typed error class. Packaging files provide ESM/CJS outputs with deterministic settings.
  • Python (templates/python/sdk_hooks.py): transport-agnostic wrappers for auth, retries, telemetry headers, and cursor pagination.
  • Go (templates/go/hooks.go): http.RoundTripper helpers for auth, telemetry, retries, and a generic paginator.
  • Java (templates/java/Hooks.java): OkHttp interceptors for auth, telemetry, retries, plus a helper to compose them.
  • C#/Ruby templates are reserved for follow-on language tracks; the banner logic already supports them.

Next steps

  • Add C#/Ruby helpers once those language tracks start.
  • Wire postprocess tests into CI to enforce clean, deterministic outputs.