Keep a document record of README changes
A README update can affect onboarding and handoffs. Ask Notis to create a document using the change information available from GitHub.
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
Generate documents from template
Tool to generate document(s) from a template by merging JSON data or uploading a data file. Use when you need to programmatically produce one or more documents and receive metadata including a download URL.
Why this helps
Important changes to repository guidance can pass without a simple record for teammates to revisit.
- Create a record when a monitored README changes.
- Keep change details in a consistent document format.
- Reduce manual documentation follow-up.
Setup
Build it in a few focused steps.
- 1Connect GitHub and Docugenerate once in the Notis portal.
- 2Create an automation in Automations, New Automation, or tell Notis from any channel.
- 3In one instruction, describe the README change document to generate from information Notis receives.
- 4Pick GitHub Repository README Changed as the trigger and choose where run reports go.
- 5Test with one real README change and confirm whether the available details suit your document.
Questions about this workflow
Will the document contain the README text?
The event description lists README metadata and previous and current blob SHAs, but does not guarantee the file contents. Provide the text or access separately if the document needs the full README.
Can I monitor a README in a specific directory?
The trigger supports a configurable directory and branch, tag, or commit. Choose the desired README trigger settings in Notis.
When this happens · Trigger
Do this · Action
Supported Triggers and Actions
Notis builds workflows that link GitHub to Docugenerate. A trigger fires from one place; an action lands in another.
GitHub triggers
Docugenerate actions
Recurring trigger
Notis starts this workflow on a schedule, such as daily, weekly, or during business hours.
Generate documents from template
Tool to generate document(s) from a template by merging JSON data or uploading a data file. Use when you need to programmatically produce one or more documents and receive metadata including a download URL.
Webhook trigger
Notis starts this workflow when an external tool or custom backend sends an HTTP request.
Generate documents as ZIP
Tool to bulk generate multiple documents into a ZIP archive. Use when you need a batch of docs packaged as ZIP.
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.
Generate document with attachments
Tool to generate a PDF with embedded attachments. Use when you need to bundle extra files into the PDF output.
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.
Generate document with merge
Tool to generate a PDF and append additional PDF files. Use when you need to merge extra pages into a generated document.
New Branch Created
Triggers when a new branch is created in a GitHub repository. Detects newly created branches. Deleted branches do not fire events.
Update Document
Tool to update a document's metadata. Use when renaming an existing document after confirming the document ID.
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.
Get or list templates
Tool to retrieve or list existing templates. Use when needing template IDs and metadata before making updates or generating documents.
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.
Update Template
Tool to update a template’s file and settings. Use after confirming the template ID and desired inputs.
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.
Connect any two apps with Notis in the middle.
GitHub and Docugenerate, or any other combination from 1,000+ integrations.
When this happens · Trigger
Do this · Action
Save your first hour today.
7-day trial of any paid plan, with 20$ of usage included.
No card. Works with personal or business Docugenerate.