Skip to content

docs: notify Testably.Site when documentation changes#755

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

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

Conversation

@vbreuss
Copy link
Copy Markdown
Member

@vbreuss vbreuss commented May 2, 2026

Adds a workflow that fires the extension-documentation-updated-event repository dispatch at Testably/Testably.Site whenever Docs/pages/** changes on main. Site responds by re-fetching this repo'''s docs and redeploying https://docs.testably.org. Requires a SITE_DISPATCH_TOKEN secret with repo write on Testably/Testably.Site.

Adds a workflow that fires the extension-documentation-updated-event
repository dispatch at Testably/Testably.Site whenever Docs/pages/**
changes on main. Site responds by re-fetching this repo'\''s docs and
redeploying https://docs.testably.org. Requires a SITE_DISPATCH_TOKEN
secret with repo write on Testably/Testably.Site.
@vbreuss vbreuss self-assigned this May 2, 2026
Copilot AI review requested due to automatic review settings May 2, 2026 20:35
@vbreuss vbreuss added the documentation Improvements or additions to documentation label May 2, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a GitHub Actions workflow to notify Testably/Testably.Site when this repository’s documentation changes so the docs site can refresh and redeploy.

Changes:

  • Adds a new notify-docs-site.yml workflow that runs on pushes to main affecting Docs/pages/**.
  • Uses peter-evans/repository-dispatch@v3 to send an extension-documentation-updated-event to Testably/Testably.Site.
  • Includes a manual trigger and also triggers when the workflow file itself changes.

Comment thread .github/workflows/notify-docs-site.yml
Comment thread .github/workflows/notify-docs-site.yml Outdated
- Guard the dispatch job with `if: github.ref == 'refs/heads/main'` so a
  manual workflow_dispatch from a topic branch cannot trigger a Site
  rebuild.
- Drop the workflow file itself from the path filter; manual dispatch
  is enough for testing changes to the workflow.
@vbreuss vbreuss enabled auto-merge (squash) May 2, 2026 20:47
@vbreuss vbreuss disabled auto-merge May 2, 2026 20:55
@vbreuss vbreuss merged commit a56e91e into main May 2, 2026
13 checks passed
@vbreuss vbreuss deleted the topic/notify-docs-site branch May 2, 2026 20:56
@github-actions
Copy link
Copy Markdown

This is addressed in release v3.2.0.

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