Skip to content

docs: notify Testably.Site when documentation changes#112

Merged
vbreuss merged 2 commits into
mainfrom
topic/notify-docs-site
May 2, 2026
Merged

docs: notify Testably.Site when documentation changes#112
vbreuss merged 2 commits into
mainfrom
topic/notify-docs-site

Conversation

@vbreuss

@vbreuss vbreuss commented May 2, 2026

Copy link
Copy Markdown
Member

Adds a workflow that fires the extension-documentation-updated-event repository dispatch at Testably/Testably.Site whenever Docs/pages/** or README.md changes on main. README.md is included because aweXpect's docs aggregator inlines it into 00-index.md via a {README} placeholder, so README changes affect the rendered site.

Requires a SITE_DISPATCH_TOKEN secret with repo write on Testably/ Testably.Site (recommended: configure once at the Testably org level).

@vbreuss vbreuss self-assigned this May 2, 2026
@vbreuss vbreuss added the documentation Improvements or additions to documentation label May 2, 2026
Copilot AI review requested due to automatic review settings May 2, 2026 21:14
@vbreuss vbreuss changed the title docs notify Testably.Site when documentation changes docs: notify Testably.Site when documentation changes May 2, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a GitHub Actions workflow to notify Testably/Testably.Site when this repo’s rendered documentation inputs change, so the site can rebuild automatically.

Changes:

  • Introduces a new workflow that triggers on pushes to main affecting Docs/pages/** or README.md.
  • Sends a repository_dispatch event (extension-documentation-updated-event) to Testably/Testably.Site with repository + SHA payload.
  • Adds manual workflow_dispatch trigger (job still gated to main via if).

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

Comment thread .github/workflows/notify-docs-site.yml
Comment thread .github/workflows/notify-docs-site.yml
@github-actions

github-actions Bot commented May 2, 2026

Copy link
Copy Markdown

Test Results

   10 files     10 suites   5s ⏱️
  554 tests   553 ✅ 1 💤 0 ❌
1 650 runs  1 649 ✅ 1 💤 0 ❌

Results for commit 4cac208.

♻️ This comment has been updated with latest results.

vbreuss added 2 commits May 3, 2026 00:14
Adds a workflow that fires the extension-documentation-updated-event
repository dispatch at Testably/Testably.Site whenever Docs/pages/** or
README.md changes on main. README.md is included because aweXpect's
docs aggregator inlines it into 00-index.md via a {README} placeholder,
so README changes affect the rendered site.

Requires a SITE_DISPATCH_TOKEN secret with repo write on Testably/
Testably.Site (recommended: configure once at the Testably org level).
@vbreuss vbreuss force-pushed the topic/notify-docs-site branch from 0913a6f to 4cac208 Compare May 2, 2026 22:14
@vbreuss vbreuss enabled auto-merge (squash) May 2, 2026 22:28
@sonarqubecloud

sonarqubecloud Bot commented May 2, 2026

Copy link
Copy Markdown

@vbreuss vbreuss merged commit 9c741bc into main May 2, 2026
19 of 20 checks passed
@vbreuss vbreuss deleted the topic/notify-docs-site branch May 2, 2026 22:30
@github-actions

Copy link
Copy Markdown

This is addressed in release v1.7.0.

@github-actions github-actions Bot added the state: released The issue is released label May 10, 2026
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 state: released The issue is released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants