Skip to content

docs: Add pre-release hardware validation step using example app AI workflow #188

@tylerkron

Description

@tylerkron

Context

Before publishing a new Daqifi.Core release, we want a repeatable hardware validation workflow that can be run by a developer or AI agent against a real DAQiFi device.

The validation logic should live with the CLI app that owns the executable hardware-facing contract: daqifi/daqifi-core-example-app#26. This daqifi-core issue is the release-process companion: once that workflow exists, document when and how release authors should run it before publishing NuGet.

Proposed Scope

Update the daqifi-core release docs/checklist to reference the example-app AI hardware validation workflow.

Potential locations:

  • README.md Publishing section
  • a new docs/RELEASE_CHECKLIST.md
  • release workflow notes near .github/workflows/release.yml

The release note should make clear that:

  • Normal CI remains dotnet build and dotnet test
  • Hardware validation is a manual/pre-release confidence step, because it requires a real DAQiFi device
  • The example app should be run against local daqifi-core sources using DaqifiCoreProjectPath
  • The CLI exit codes and explicit thresholds are the pass/fail source of truth
  • AI/Codex can orchestrate the workflow, collect artifacts, and summarize results

Acceptance Criteria

  • daqifi-core release docs include a pre-release hardware validation step
  • Docs link to feat: Add AI hardware-validation skill for release testing with real DAQiFi devices daqifi-core-example-app#26 or the final workflow doc/skill created by that ticket
  • Docs explain that hardware validation requires configured real hardware and is not part of default GitHub-hosted CI
  • Docs show the local-core validation pattern using -p:DaqifiCoreProjectPath=src/Daqifi.Core/Daqifi.Core.csproj
  • Docs state that pass/fail is based on CLI exit codes and validation thresholds, not AI judgment alone

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions