Reusable Workflow Reference¶
In a nutshell
This page is the index to the detailed reference for every shared automation recipe ("workflow") that OVOS projects can plug in. The full specs are split by lifecycle stage: release (publish, version bump), PR (build, test, and check gates run on pull requests, itself an index to several topic pages), and quality (lint, coverage, security scans, notifications). This index is aimed at maintainers wiring up a project's testing and release machinery; if you just want the big picture of what these automations are for, start with the gh-automations overview. See also the Glossary.
All reusable workflows are in .github/workflows/ and are called via:
Ref: Always use
@dev.
Workflow index¶
| Workflow | Purpose | Documented on |
|---|---|---|
publish-alpha.yml |
Bumps the version on PR merge to dev and opens a release PR to master. |
Release Workflows |
publish-stable.yml |
Removes the alpha suffix and tags a stable GitHub release on push to master. |
Release Workflows |
release-preview.yml |
Predicts the next version from PR labels/title and posts a preview to the PR comment. | Release Workflows |
build-tests.yml |
Runs build, install, and optional tests across a Python version matrix. | Build Checks |
channel-compat.yml |
Runs the test suite against the versions an OVOS distro release channel pins. | Build Checks |
opm-check.yml |
Verifies the package is discoverable and valid as an OVOS plugin (OPM). | Plugin, License, and Repo Checks |
ovoscope.yml |
Runs ovoscope end-to-end skill tests on a single Python version. | Skill Test Workflows |
license-check.yml |
Checks installed dependencies against the OVOS universal donor license policy. | Plugin, License, and Repo Checks |
repo-health.yml |
Checks for required repo files and greets first-time contributors. | Plugin, License, and Repo Checks |
skill-check.yml |
Analyses an OVOS skill repo for locale structure and skill.json validity. |
Skill and Locale Checks |
python-support.yml (deprecated) |
Legacy install matrix across Python versions and install modes. | Build Checks |
locale-check.yml |
Verifies locale folders are correctly included in the package build. | Skill and Locale Checks |
spec-lint.yml |
Runs ovos-spec-lint against a skill's locale folder for OVOS-INTENT-½ conformance. |
Skill and Locale Checks |
intent-case-tests.yml |
Runs the file-based ovoscope intent-routing accuracy matrix, sharded by language. | Skill Test Workflows |
tts-intelligibility.yml |
Scores TTS output intelligibility via a synthesize-then-transcribe round trip. | Skill Test Workflows |
coverage.yml |
Runs pytest --cov, posts a coverage report, and optionally deploys HTML to gh-pages. |
Coverage and Security Workflows |
coverage-pages.yml (deprecated) |
Legacy coverage-to-gh-pages deployment, replaced by coverage.yml. |
Coverage and Security Workflows |
pip-audit.yml |
Scans dependencies for known CVEs and optionally uploads a SARIF report. | Coverage and Security Workflows |
downstream-check.yml |
Reports which packages depend on a given package, using pipdeptree. |
Coverage and Security Workflows |
lint.yml |
Runs ruff and/or pre-commit. |
Lint and Docs Workflows |
type-check.yml |
Runs mypy, informational only unless fail_on_errors: true. |
Lint and Docs Workflows |
docs-check.yml |
Verifies required documentation files exist and optionally lints Markdown. | Lint and Docs Workflows |
notify-matrix.yml |
Sends a message to the OVOS Matrix channel. | Lint and Docs Workflows |
The PR Checks Comment Pattern and Scripts Reference sections, describing the shared PR-comment mechanism and the Python scripts used across all of the above workflows, live on the PR Comment Pattern and Scripts page.
Source code: OpenVoiceOS/gh-automations.
Read next: PR Check Workflows · Quality Workflows Related: gh-automations Overview · Release Workflows · Release Flow · Contributing