Refresh Algolia when a GitHub README changes
Make the current setup instructions and project overview easy to locate without checking every repository.
Trigger
GitHub Repository README Changed
Triggers when the README file in a specific repository directory changes. Monitors the README in a configurable directory and branch/tag/commit. The payload includes the current README metadata (filename, path, SHA, size, URLs), the previous and current git blob SHAs, and a list of which tracked fields changed.
Action
Partial Update Objects
Tool to partially update multiple records in the specified index. use when you need to change only selected fields of many objects without replacing entire records. use after confirming objectids and desired updates.
Why this helps
Teams search an outdated documentation index, then lose focus verifying whether the source README has changed.
- Surface current setup guidance
- Reduce repository hopping
Setup
Build it in a few focused steps.
- 1Connect GitHub and Algolia to Notis once.
- 2Create a new automation from the portal.
- 3In one prompt, ask Notis to refresh the matching Algolia documentation record when the README changes.
- 4Pick GitHub Repository README Changed and a report channel.
- 5Make a small README update and test a search.
Questions about this workflow
Can this focus on one repository?
Yes. Select the repository when choosing the GitHub trigger.
When this happens · Trigger
Do this · Action
Supported Triggers and Actions
Notis builds workflows that link GitHub to Algolia. A trigger fires from one place; an action lands in another.
GitHub triggers
Algolia actions
New Workflow Artifact Created
Triggers when a new workflow artifact is created in a GitHub repository. Monitors for newly created GitHub Actions workflow artifacts. Optionally filters by artifact name to restrict monitoring to specific artifacts.
Add AB Test
Tool to create an ab test comparing search performance between two variants. use to test different index configurations or search parameters and measure impact on click-through and conversion rates.
Branch Changed
Triggers when a GitHub branch changes. Monitors a specific branch for: - New commits pushed (head commit SHA changes) - Protection status toggled (branch becomes protected or unprotected) - Protection settings changed, including: required status checks and their enforcement level, admin enforcement, required pull request reviews (dismiss stale reviews, code owner reviews, approving review count, last push approval), required linear history, force push allowance, deletion allowance, conversation resolution, branch locking, and fork syncing.
Browse Algolia Index
Tool to retrieve all records from an index. use when you need to export or iterate through an entire index dataset.
New Branch Created
Triggers when a new branch is created in a GitHub repository. Detects newly created branches. Deleted branches do not fire events.
Clear Objects
Tool to clear records of an index without affecting settings. use when you need to completely wipe all objects (e.g., after a bulk reindex) while preserving index configuration.
Check Run Status / Conclusion Changed
Triggers when a specific GitHub check run changes its status or conclusion. Monitors a single check run for changes to: status (queued, in_progress, completed, etc.), conclusion (success, failure, neutral, cancelled, skipped, timed_out, action_required), started_at, and completed_at.
Clear Rules
Tool to delete all rules in an index. use when you need to wipe all rules before re-creating them. use after confirming no critical rules require retention.
Check Suite Status / Conclusion Changed
Triggers when a GitHub check suite changes its status or conclusion for a given ref. Monitors all check suites associated with a git reference (branch, tag, or commit SHA) for changes to status (queued, in_progress, completed, etc.) and conclusion (success, failure, neutral, cancelled, skipped, timed_out, action_required, startup_failure, stale). Optionally filters by GitHub App ID.
Clicked Object IDs
Tool to send a click event to algolia to capture clicked items. use immediately after a user click outside of search contexts to report click events.
New Code Scanning Alert Created
Triggers when a new code scanning alert is created in a repository. Fires an event for each newly created code scanning alert detected in the configured repository. Alerts can be filtered by Git reference, scanning tool, state, and severity. The payload includes the alert number, rule details, tool information, state, severity, and the location of the most recent instance.
Clicked Object IDs After Search
Tool to send a click event after a search response. use when you want to report which items a user clicked in search results.
New Repository Collaborator Added
Triggers when a new collaborator is added to a GitHub repository. Monitors the full list of collaborators on a repository and fires an event for each newly added collaborator. The payload includes the collaborator's GitHub username, account ID, profile URL, avatar URL, permission flags (pull, triage, push, maintain, admin), and assigned role name.
Converted Object IDs
Tool to send a conversion event for items outside of search context. use when tracking conversions on category pages or external flows unrelated to algolia search.
Commit Event
Triggered when a new commit is pushed to a repository.
Copy Index
Tool to copy the specified index to a new index. use when you need to duplicate an existing index including records, settings, synonyms, and rules after confirming source and destination names.
Connect any two apps with Notis in the middle.
Not just GitHub and Algolia. Any combination from 1,000+ integrations.
When this happens · Trigger
Do this · Action
Save your first hour today.
7 days free trial with 20$ free usage included.
No card. Works with personal or business Algolia.