Skip to content

Development Workflow

Kieron Lanning edited this page Apr 16, 2026 · 2 revisions

Development Workflow

Common commands

The repository uses just for local workflows.

just tools
just restore
just build
just test
just check
just pack
just version
just version-next
just version-bump

What they do

Command Purpose
just tools Restore local .NET tools such as CSharpier
just restore Restore the solution
just build Build the solution
just test Run the real test projects individually with shell-neutral recipes
just check Run formatting checks
just pack Create NuGet packages in artifacts/packages using the package.json version
just version Read the current shared package version from package.json
just version-next Preview the next release with commit-and-tag-version --dry-run
just version-bump Create the local release commit with npm run release

Version source

The shared package version is centralized in:

/package.json

CI / CD shape

  • CI restores tools and packages, then runs check, build, and tests.
  • CD triggers when package.json changes on main or on manual dispatch, blocks duplicate remote tags and GitHub releases, packs the NuGet packages, and publishes the .nupkg / .snupkg artifacts on the GitHub release.

Release notes

  • Install the Node tooling with npm install or bun install before running release commands locally.
  • Create a release commit with npm run release or bun run release.
  • Do not create or push release tags manually; GitHub Actions owns remote tag creation and the GitHub release.

Testing notes

  • Integration tests typically require Docker because the repository uses Testcontainers.
  • Some provider-specific tests may depend on optional infrastructure availability in the current environment.

Clone this wiki locally