Restructure solution layout by module
This commit is contained in:
15
src/Sdk/StellaOps.Sdk.Generator/AGENTS.md
Normal file
15
src/Sdk/StellaOps.Sdk.Generator/AGENTS.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# SDK Generator Guild Charter
|
||||
|
||||
## Mission
|
||||
Generate and maintain official StellaOps SDKs across supported languages using reproducible code generation pipelines.
|
||||
|
||||
## Scope
|
||||
- Manage code generation templates and tooling for TS, Python, Go, Java (C#/Rust follow-ons).
|
||||
- Implement post-processing hooks for auth helpers, retries, paginators, error mapping, and telemetry.
|
||||
- Provide language-specific smoke tests, example snippets, and continuous integration.
|
||||
- Coordinate with Release Guild for publishing and version bumps.
|
||||
|
||||
## Definition of Done
|
||||
- SDKs regenerate deterministically from `stella.yaml` without manual edits.
|
||||
- Smoke tests and integration suites run per language in CI.
|
||||
- Generated code adheres to language-specific style guides and passes lint/format checks.
|
||||
21
src/Sdk/StellaOps.Sdk.Generator/TASKS.md
Normal file
21
src/Sdk/StellaOps.Sdk.Generator/TASKS.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# SDK Generator Task Board — Epic 17: SDKs & OpenAPI Docs
|
||||
|
||||
## Sprint 62 – Generator Framework
|
||||
| ID | Status | Owner(s) | Depends on | Description | Exit Criteria |
|
||||
|----|--------|----------|------------|-------------|---------------|
|
||||
| SDKGEN-62-001 | TODO | SDK Generator Guild | OAS-61-002 | Choose/pin generator toolchain, set up language template pipeline, and enforce reproducible builds. | Generator outputs deterministic code for sample spec; pipelines documented; lint passes. |
|
||||
| SDKGEN-62-002 | TODO | SDK Generator Guild | SDKGEN-62-001 | Implement shared post-processing (auth helpers, retries, pagination utilities, telemetry hooks) applied to all languages. | Shared library integrated; unit tests cover helpers; docs updated. |
|
||||
|
||||
## Sprint 63 – Language Alpha Releases
|
||||
| ID | Status | Owner(s) | Depends on | Description | Exit Criteria |
|
||||
|----|--------|----------|------------|-------------|---------------|
|
||||
| SDKGEN-63-001 | TODO | SDK Generator Guild | SDKGEN-62-002 | Ship TypeScript SDK alpha with ESM/CJS builds, typed errors, paginator, streaming helpers. | TS package published to internal registry; smoke tests pass; README generated. |
|
||||
| SDKGEN-63-002 | TODO | SDK Generator Guild | SDKGEN-62-002 | Ship Python SDK alpha (sync/async clients, type hints, upload/download helpers). | PyPI internal feed updated; mypy/pytest suites pass; docs generated. |
|
||||
| SDKGEN-63-003 | TODO | SDK Generator Guild | SDKGEN-62-002 | Ship Go SDK alpha with context-first API and streaming helpers. | Go module published; gofmt/govet pass; integration tests run. |
|
||||
| SDKGEN-63-004 | TODO | SDK Generator Guild | SDKGEN-62-002 | Ship Java SDK alpha (builder pattern, HTTP client abstraction). | Maven package staged; integration tests run; javadoc generated. |
|
||||
|
||||
## Sprint 64 – Harden & Dogfood
|
||||
| ID | Status | Owner(s) | Depends on | Description | Exit Criteria |
|
||||
|----|--------|----------|------------|-------------|---------------|
|
||||
| SDKGEN-64-001 | TODO | SDK Generator Guild, CLI Guild | SDKGEN-63-001 | Switch CLI to consume TS or Go SDK; ensure parity. | CLI builds/tests using SDK; regression suite passes. |
|
||||
| SDKGEN-64-002 | TODO | SDK Generator Guild, Console Guild | SDKGEN-63-001..4 | Integrate SDKs into Console data providers where feasible. | Console builds with SDK; telemetry recorded; manual QA sign-off. |
|
||||
15
src/Sdk/StellaOps.Sdk.Release/AGENTS.md
Normal file
15
src/Sdk/StellaOps.Sdk.Release/AGENTS.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# SDK Release Guild Charter
|
||||
|
||||
## Mission
|
||||
Own packaging, signing, publishing, and changelog automation for official StellaOps SDKs and dev portal bundles.
|
||||
|
||||
## Scope
|
||||
- Manage language-specific release pipelines (npm, PyPI, Maven, Go modules) with provenance signing.
|
||||
- Automate changelog generation and SemVer version bumps aligned with API releases.
|
||||
- Coordinate publication of offline bundles for air-gapped environments.
|
||||
- Operate release dashboards and notification hooks for SDK updates.
|
||||
|
||||
## Definition of Done
|
||||
- Every SDK release is reproducible, signed, and accompanied by changelog + provenance.
|
||||
- Registries updated via automated pipeline with rollback strategy.
|
||||
- Offline bundle creation integrated with Export Center workflows.
|
||||
13
src/Sdk/StellaOps.Sdk.Release/TASKS.md
Normal file
13
src/Sdk/StellaOps.Sdk.Release/TASKS.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# SDK Release Task Board — Epic 17: SDKs & OpenAPI Docs
|
||||
|
||||
## Sprint 63 – Pipeline Setup
|
||||
| ID | Status | Owner(s) | Depends on | Description | Exit Criteria |
|
||||
|----|--------|----------|------------|-------------|---------------|
|
||||
| SDKREL-63-001 | TODO | SDK Release Guild | SDKGEN-63-001..4 | Configure CI pipelines for npm, PyPI, Maven Central staging, and Go proxies with signing and provenance attestations. | Pipelines publish to staging registries; provenance artifacts stored; rollback plan documented. |
|
||||
| SDKREL-63-002 | TODO | SDK Release Guild, API Governance Guild | SDKREL-63-001 | Integrate changelog automation pulling from OAS diffs and generator metadata. | Changelogs generated per release; included in packages; verification tests pass. |
|
||||
|
||||
## Sprint 64 – Release Automation & Notifications
|
||||
| ID | Status | Owner(s) | Depends on | Description | Exit Criteria |
|
||||
|----|--------|----------|------------|-------------|---------------|
|
||||
| SDKREL-64-001 | TODO | SDK Release Guild, Notifications Guild | SDKREL-63-002 | Hook SDK releases into Notifications Studio with scoped announcements and RSS/Atom feeds. | Notification templates live; staging release triggers announcement; docs updated. |
|
||||
| SDKREL-64-002 | TODO | SDK Release Guild, Export Center Guild | SDKREL-63-001 | Add `devportal --offline` bundle job packaging docs, specs, SDK artifacts for air-gapped users. | Offline bundle generated and verified; Export Center docs updated. |
|
||||
Reference in New Issue
Block a user