Wiki Update Notifications¶
This page explains how the automated "Wiki Updated" Slack notification works and how to set it up.
How It Works¶
Every time a change is pushed or merged into main, GitHub Actions runs a workflow that:
- Detects which wiki pages (
.mdfiles underdocs/) changed in the push - Looks up each page's title (the first
# Headingin the file) and its URL on the wiki - Posts a Wiki Updated message to Slack listing each changed page as a link
Example message:
📚 Wiki Updated • SOP: Adding a Custom Domain for a Brand
The workflow only fires if at least one wiki page changed. Other file types (images, config files, etc.) and deleted pages do not appear in the notification.
Claude Project sync is no longer part of this notification. The message is a general alert only — it does not list Claude Projects or re-upload steps.
Files Involved¶
| File | Purpose |
|---|---|
.github/workflows/claude-sync-notify.yml |
GitHub Actions workflow that detects changed pages and triggers the notification |
scripts/sync-check.js |
Node.js script that builds the page list and posts to Slack (also runnable locally) |
Running the Check Locally¶
You can preview what the notification would list without posting to Slack. No dependencies need to be installed.
Pages changed in the last commit¶
Pages changed since a specific commit¶
Replace abc1234 with any valid commit hash. You can find recent hashes with:
Example output¶
=== Wiki Updated (2) ===
- Acceptable Use Policy
https://wiki.gotrove.ai/operations/acceptable-use-policy/
- Information Security Policy
https://wiki.gotrove.ai/security/information-security-policy/
Setting Up the Slack Webhook¶
The workflow posts to Slack via an incoming webhook URL stored as a GitHub Secret.
Create the webhook¶
- Go to your Slack workspace → Apps → search for Incoming Webhooks
- Click Add to Slack
- Choose the channel to post to (e.g.
#wiki-updates) - Copy the webhook URL
Add it to GitHub Secrets¶
- Go to the
wiki-and-docsrepository on GitHub - Click Settings → Secrets and variables → Actions
- Click New repository secret
- Name:
SLACK_WEBHOOK_URL - Value: paste the webhook URL
- Click Add secret
Updating the webhook URL¶
If the webhook URL changes (e.g. the Slack app is re-installed or the channel changes):
- Follow the steps above to create a new webhook URL
- Go to Settings → Secrets and variables → Actions in the repo
- Find
SLACK_WEBHOOK_URLand click Update - Paste the new URL and save
The workflow will use the new URL on the next push to main — no code changes required.
Troubleshooting¶
No Slack message arrived after a push
- Check the Actions tab in the GitHub repo to see if the workflow ran
- If it ran and passed, check that
SLACK_WEBHOOK_URLis set correctly in GitHub Secrets - If the workflow was skipped, confirm that at least one
.mdfile underdocs/was included in the push
A page title looks wrong
The title is taken from the first # Heading in the page. If the page has no heading, the file name is used instead. Add or fix the heading in the page.
A page link goes to a 404
The link is built from the file path (docs/section/page.md → /section/page/). If the page was published under a different URL, check the file's location and the site's deployment status.