Skip to content

Follow the IOExtend release order in release.yml - #16

Open
mahach666 wants to merge 2 commits into
mainfrom
chore/target-architecture
Open

mahach666 wants to merge 2 commits into
mainfrom
chore/target-architecture

Conversation

@mahach666

@mahach666 mahach666 commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

What changes and why

Aligns the repository with the IOExtend target architecture (the org profile "Architecture" section and the
2026-11-12-ioextend-target-architecture document) — the transition RvtIO and NwcIO have already started. Two parts:

1. Release choreography (§2.4)

  • release.yml pushes the NuGet packages before the GitHub release is created. A refused first publication of a
    package id can be fixed and the job re-run, because --skip-duplicate makes the push repeatable and no release
    exists yet. The changelog section for the version is checked (release notes extracted) before anything is published.
  • A tag whose version contains a hyphen, such as v0.2.0-preview.1, is published as a GitHub prerelease
    (v0.1.0 was published as a full release despite being a preview).
  • CONTRIBUTING "Releases" describes the new order; CHANGELOG records it under [Unreleased].
  • The workflow keeps PlaIO's early NUGET_USER validation and reads the login user from the repository variable,
    where RvtIO and NwcIO hard-code the profile name.

2. The core / scene / viewer separation

  • Verified: the core holds no scene types and no viewer code, so there is nothing to move out; the only JSON output
    (DirectoryJson) is the engine-native dump the architecture keeps in engines.
  • New src/PlaIO.Scene (namespace PlaIO.Scene), the adapter where the scene mapping lives as it did for
    RvtIO.Scene and NwcIO.Scene: PlaSceneReader.Read(path) turns a container into an IOScene SceneDocument —
    one model per file, no elements yet. The scene holds no guesses; the container-only diagnostic (Info) says what is
    missing. The Key derivation is frozen and covered by identity tests: PlaSceneOptions.ModelKey, else the file
    name with its extension.
  • IsPackable=false: the adapter does not publish and no NuGet id is committed until the reader decodes elements
    and geometry — the adapter trigger of the target architecture ("PlaIO decodes geometry / has elements to export /
    has a writer"). This is how IfcIO.Scene and RvtIO.Scene started (B3/B4: unpackable until the gate).
  • Wiring mirrors the engines: IOScene [0.1.1, 0.2.0-0.0) + NoWarn NU5104 in Directory.Packages.props, the exact
    engine pin target (PinProjectReferencesExactly) ready for the flip, docs/scene.md, docfx.json and docs.yml
    paths, tests in tests/PlaIO.Tests (the RvtIO style: RvtSceneIdentitySampleTests lives in RvtIO.Tests).
  • README states the ecosystem position; docs/dependencies.md documents the adapter's IOScene dependency and fixes
    a stale Test.Sdk version in it.

How it was checked

  • dotnet build PlaIO.slnx -c Release has no warnings
  • dotnet test PlaIO.slnx -c Release passes (152 passed, 13 skipped — the sample tests gated by PLAIO_TEST_FILES;
    6 new adapter tests, identity literals included)
  • Output of plaio info, plaio blocks and plaio directory on the same files is identical before and after — no
    reader or CLI code is touched, so the outputs are identical by construction
  • No Archicad files, customer data or vendor files are added
  • tools/pack-release.ps1 produces the same 9 artifacts (PlaIO.Scene is not packed while IsPackable=false)
  • dotnet docfx docfx.json --warningsAsErrors builds with 0 warnings (the adapter API page included)
  • The release workflow is step-for-step the RvtIO canonical release workflow; a normalized diff shows only the
    PlaIO-specific early NUGET_USER validation and the variable-based login user

The workflow pushes the NuGet packages before the GitHub release is created (a refused first publication can be fixed and the job re-run), publishes a hyphen tag as a prerelease, and checks the changelog section before anything is published. The README states the ecosystem position and the adapter trigger; CONTRIBUTING describes the new order; CHANGELOG records the change.
The separation of responsibilities of the target architecture: the core stays a leaf, the scene mapping lives in src/PlaIO.Scene, the viewer stays IOViewer. PlaSceneReader.Read(path) produces a valid scene of one model (the frozen Key derivation, SourceFormat pla/pln, the container-only diagnostic) and no elements while the container reader decodes none. The project is IsPackable=false and is not published; it ships on a PlaIO tag when the reader decodes elements and geometry. Tests in PlaIO.Tests freeze the key derivation; docs/scene.md documents the mapping, the limits and the publication rule.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant