test-release-canary

Dispatch and debug the Release Canary workflow that smoke-tests published OpenShell install artifacts.

8.5k|1.3k|Updated Feb 24, 2026
One-click install
npx skills add https://github.com/NVIDIA/OpenShell --skill test-release-canary
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: test-release-canary
Source: https://github.com/NVIDIA/OpenShell/tree/main/.agents/skills/test-release-canary
Command: npx skills add https://github.com/NVIDIA/OpenShell --skill test-release-canary

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After each Release Dev publish, teams need to confirm that the published OpenShell artifacts (install.sh packages, Helm chart) actually install and run on stock environments before tagging a public release. This Skill guides manual dispatch, iteration, local reproduction, and failure diagnosis of the Release Canary GitHub Actions workflow.

Core Features & Use Cases

  • Manual Canary Dispatch: Run the release-canary.yml workflow on any branch with gh CLI commands and watch or inspect failed jobs.
  • Local kind Reproduction: Recreate the Kubernetes canary job locally with kind, Helm, and kubectl to smoke-test the OCI chart, including SHA-pinned dev builds.
  • Failure Diagnosis: A symptom-to-cause table maps macOS, Ubuntu, Fedora, and Kubernetes job failures to likely causes and the exact logs to inspect.
  • Use Case: You modified .github/workflows/release-canary.yml on a branch and want to validate the change against known-good published artifacts before merging, then debug a failing helm install step in the kind cluster.

Quick Start

Ask the agent to manually dispatch the release canary workflow on the current branch and watch the run for failures.

Frequently Asked Questions about test-release-canary

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I manually dispatch the release canary workflow?

Run gh workflow run release-canary.yml --ref with your current branch name, then use gh run list and gh run watch to monitor it. Manual dispatch tests your branch's workflow logic against main's published artifacts.

How do I reproduce the Kubernetes canary job locally?

Create a kind cluster, install the OCI Helm chart with --version 0.0.0-dev and server.disableTls=true, wait for the gateway pod to be Ready, then port-forward 8080 and register the gateway with the openshell CLI. Tear down with kind delete cluster.

Can I test the Helm chart from a specific dev build SHA?

Yes. Release Dev publishes an immutable chart version 0.0.0-dev.<sha> alongside the floating 0.0.0-dev tag. Swap the version in the helm install command to pin the chart and its SHA-tagged gateway and supervisor images.

Why does the canary kubernetes job fail on helm install?

A helm install --wait failure usually means the chart did not deploy within 5 minutes, typically from image pull errors or failing readiness probes. The job's diagnostics step dumps helm status, the rendered manifest, pod descriptions, and logs.

Does the release canary test the TypeScript SDK?

No. The canary does not install or import @nvidia/openshell-sdk. TypeScript SDK validation lives in a separate branch check with a publish dry-run, and the tagged release workflow publishes the package to GitHub Packages.