Skip to content

Release Flow

Stable Telemetry SourceGenerator Reviewed 2026-09-17 purview-dev/telemetry-sourcegenerator activity c-sharp distributed-tracing dotnet events high-performance-logging instrumentation logging melt metrics nuget observability open-telemetry open-telemetry-csharp otel roslyn source-generator spans telemetry tracing

Release Flow

Section titled “Release Flow”

Releases are driven by GitHub Actions using the reusable purview-dev/build pipelines. No release steps are performed manually.

Feature branch
  → PR to main      (pr.yml runs purview-build.yml: restore + build + lint + tests)
  → merge to main   (release.yml runs purview-release.yml: build, test, pack, publish)
  → GitHub Release  (NuGet package + changelog, created by the pipeline)

Workflow components

Section titled “Workflow components”
ComponentFilePurpose
PR gate.github/workflows/pr.ymlRuns the reusable purview-dev/build purview-build.yml pipeline (restore, build, lint, tests) and builds/tests the sample solution.
CD pipeline.github/workflows/release.ymlRuns the reusable purview-dev/build purview-release.yml pipeline on push to main.
Local pipelineJustfile pipeline-* recipesMirror the CI/CD pipelines locally via the Purview.Build tool (.tools/purview-build).

Developer workflow

Section titled “Developer workflow”
  1. Create a feature branch and make your changes.
  2. Validate locally with just pipeline-pr (restore, build, lint, tests — the same gate CI enforces).
  3. Push and open a PR to main. pr.yml must pass (build, lint, tests, plus the sample build/test job).
  4. Merge the PR into main.
  5. The release is published automatically — release.yml restores and builds the main and sample solutions, runs the integration tests, packs the NuGet package, publishes it, and creates a GitHub Release.

Versioning

Section titled “Versioning”
  • The version lives in package.json. Current Version: 5.0.0-prerelease.8
  • It is applied to Version/PackageVersion by Purview.BuildSdk via package.json version detection.
  • just version prints the current version.
  • After bumping package.json, run just update-version to sync the version into docs/samples.

Building the package locally

Section titled “Building the package locally”
CommandPurpose
just packUpdates the version, then packs the NuGet package into artifacts/.
just pipeline-local-releasePacks and publishes to a local NuGet feed (see the Justfile note on argument quoting for the feed path).
just pipeline-releaseFull release pipeline (build, test, pack, publish, GitHub release).

Pre-release validation

Section titled “Pre-release validation”

Before a release, validate locally:

  1. just pipeline-pr — restore, build, lint, tests.
  2. just build-s && just test-s — sample solution build and tests.
  3. just pipeline-local-release — confirm the pack + local publish succeed.

Releasing

Section titled “Releasing”
  1. Bump the version in package.json.
  2. Run just update-version to sync docs/samples.
  3. Push a PR with the version bump; merge to main.
  4. release.yml publishes the release automatically.

The legacy scripts/setup-release.* files describe a changeset-based (@changesets/cli) flow that is not used by this repository. They are retained for reference only; the actual release automation lives in .github/workflows/pr.yml and .github/workflows/release.yml.

See also

Section titled “See also”