work
This commit is contained in:
38
docs/modules/scanner/design/surface-env-release.md
Normal file
38
docs/modules/scanner/design/surface-env-release.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Surface.Env Package Release Note
|
||||
|
||||
Status: Published · 2025-11-23
|
||||
Owners: Scanner Guild · BuildX Plugin Guild · Ops Guild
|
||||
Scope: Unblock SURFACE-ENV-03 and BuildX adoption by pinning package version + offline bundle path for `StellaOps.Scanner.Surface.Env`.
|
||||
|
||||
## Version & Build Inputs
|
||||
- **Package ID:** `StellaOps.Scanner.Surface.Env`
|
||||
- **Version:** `0.1.0-alpha.20251123` (semantic, date-stamped for sprint 136)
|
||||
- **Source:** `src/Scanner/__Libraries/StellaOps.Scanner.Surface.Env/StellaOps.Scanner.Surface.Env.csproj`
|
||||
- **Pack command:**
|
||||
- `dotnet pack src/Scanner/__Libraries/StellaOps.Scanner.Surface.Env/StellaOps.Scanner.Surface.Env.csproj -c Release -o local-nugets /p:Version=0.1.0-alpha.20251123`
|
||||
- **Restore sources:** `local-nugets/; dotnet-public; nuget.org` (per `Directory.Build.props`).
|
||||
|
||||
## Offline / Air-Gap Artefacts
|
||||
- Copy the produced `.nupkg` to `offline/packages/nugets/StellaOps.Scanner.Surface.Env.0.1.0-alpha.20251123.nupkg`.
|
||||
- Manifest entry:
|
||||
- `packageId`: `StellaOps.Scanner.Surface.Env`
|
||||
- `version`: `0.1.0-alpha.20251123`
|
||||
- `sha256`: `7f79ec14cc52f0880904eccb6fbc8120bd7d316ab8d6390fef054ed11ee4716e`
|
||||
- `size`: `14080`
|
||||
- `createdAt`: `2025-11-23T00:00:00Z`
|
||||
- No external network calls are required after packing; the offline kit consumes the local file.
|
||||
|
||||
## Consumer Guidance
|
||||
- BuildX plugin (`src/Scanner/StellaOps.Scanner.Sbomer.BuildXPlugin`) should reference `0.1.0-alpha.20251123` via the curated feed `local-nugets/`.
|
||||
- Scanner WebService/Worker should use the same version once Surface.Env integration tests pass (SCANNER-ENV-02).
|
||||
- Surface.Validation and Surface.Secrets depend on the env settings; keep prefix defaults and determinism rules from `design/surface-env.md`.
|
||||
|
||||
## Verification
|
||||
- Run `dotnet test` for env library once restore is stable; until then, manual pack is acceptable for BuildX smoke tests.
|
||||
- Validate package contents:
|
||||
- Contains `StellaOps.Scanner.Surface.Env.dll` and `StellaOps.Scanner.Surface.Env.xml` docs.
|
||||
- `lib/net10.0/` target only; no native assets.
|
||||
- Ensure `local-nugets/` feed lists the package with `nuget list -Source local-nugets` before wiring CI.
|
||||
|
||||
## Change Log
|
||||
- 2025-11-23: Initial release note created to unblock SCANNER-ENV-03 and offline kit wiring; version pinned to `0.1.0-alpha.20251123`.
|
||||
Reference in New Issue
Block a user