Skip to content

chore: fix CI/CD pipeline section and add skip functionality docs#564

Merged
cidrblock merged 3 commits into
ansible:mainfrom
dbrennand:docs/tox-ansible-ci-cd
Jun 12, 2026
Merged

chore: fix CI/CD pipeline section and add skip functionality docs#564
cidrblock merged 3 commits into
ansible:mainfrom
dbrennand:docs/tox-ansible-ci-cd

Conversation

@dbrennand

Copy link
Copy Markdown
Contributor

Summary

  • Replaces the broken reference to a non-existent .github/workflows/run.yml reusable workflow with a self-contained GitHub Actions workflow snippet demonstrating how to use --gh-matrix to dynamically generate a test matrix.
  • Adds a new Skip functionality section documenting the skip option for both pyproject.toml and tox-ansible.ini.

Details

The previous CI/CD pipeline section referenced ansible/tox-ansible/.github/workflows/run.yml@main, which does not exist. This caused confusion for users trying to integrate tox-ansible into their GitHub Actions pipelines (see #548).

The updated section:

  • Explains how tox-ansible generates a GitHub Actions matrix using --gh-matrix and --ansible flags.
  • Shows a two-job workflow pattern: a generate-matrix job that produces the envlist output, and a tox-ansible job that consumes it via a matrix strategy.
  • Includes a note that the snippet is illustrative and not production-ready (Python setup and tox-ansible installation steps are omitted for readability).

Fixes #548

🤖 Generated with Claude Code

Previously referenced an old workflow which doesn't exist anymore. Add minimal snippet example.
@dbrennand dbrennand requested a review from a team as a code owner June 12, 2026 16:03
@dbrennand dbrennand changed the title docs: fix CI/CD pipeline section and add skip functionality docs chore: fix CI/CD pipeline section and add skip functionality docs Jun 12, 2026
@github-actions github-actions Bot added the chore Maintenance tasks, not affecting shipped product label Jun 12, 2026
@cidrblock cidrblock merged commit 1b64309 into ansible:main Jun 12, 2026
53 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Maintenance tasks, not affecting shipped product

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Documentation: User Guide References Non Existent GitHub Action Workflow

2 participants