Skip to content

docs: add spread testing for tutorial#66

Merged
florentianayuwono merged 12 commits into
mainfrom
docs/spread-testing-ISD-5184
Feb 22, 2026
Merged

docs: add spread testing for tutorial#66
florentianayuwono merged 12 commits into
mainfrom
docs/spread-testing-ISD-5184

Conversation

@florentianayuwono

@florentianayuwono florentianayuwono commented Feb 19, 2026

Copy link
Copy Markdown
Collaborator

Applicable spec:

Overview

Add automated spread testing for tutorial to automatically validate the tutorial by running all commands in it.

Rationale

To ensure that the tutorial is always working and up to date.

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

@florentianayuwono florentianayuwono self-assigned this Feb 19, 2026
@florentianayuwono florentianayuwono requested a review from a team as a code owner February 19, 2026 13:09
@florentianayuwono florentianayuwono added the documentation Improvements or additions to documentation label Feb 19, 2026
@florentianayuwono florentianayuwono removed the request for review from a team February 19, 2026 13:53

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds automated Spread testing infrastructure to validate the tutorial documentation by executing all commands described in it. The changes introduce a GitHub Actions workflow that uses the canonical/operator-workflows reusable workflow to generate and run Spread tests from the tutorial markdown file.

Changes:

  • Added spread.yaml configuration file to define test environments and execution parameters
  • Added SPREAD comment annotations to docs/tutorial.md to control automated test execution
  • Added GitHub Actions workflow to trigger spread tests on tutorial changes
  • Updated changelog with the new feature

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
spread.yaml New configuration file defining multipass and github-ci backends, test suites, and environment setup for automated tutorial testing
docs/tutorial.md Added SPREAD SKIP markers around interactive/manual sections and a SPREAD command for automated connection testing
docs/changelog.md Added changelog entry for tutorial testing feature
.github/workflows/docs_spread.yaml New workflow to trigger spread tests when tutorial.md is modified

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread spread.yaml Outdated
Comment thread spread.yaml Outdated
Comment thread spread.yaml Outdated
Comment thread docs/tutorial.md Outdated

@cbartz cbartz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TY! Some questions.

Comment thread docs/tutorial.md
Comment thread spread.yaml Outdated

@cbartz cbartz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I have no spread experience, but changes look plausible to me.

@florentianayuwono florentianayuwono enabled auto-merge (squash) February 20, 2026 13:54

@erinecon erinecon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for adding a Spread test to the tutorial!

@florentianayuwono florentianayuwono merged commit 5ff3aaf into main Feb 22, 2026
16 of 18 checks passed
@florentianayuwono florentianayuwono deleted the docs/spread-testing-ISD-5184 branch February 22, 2026 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Libraries: OK

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants