Keep Codacy Context Near README Changes
A documentation update can be a simple reminder to keep quality context current.
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
List Projects
Tool to list all projects accessible to the authenticated user. use when you need a list of repositories after confirming api token validity.
Why this helps
README edits often signal a repository change, but quality ownership and project context remain disconnected.
- Adds visibility to maintenance work
- Reduces forgotten quality follow-up
- Helps keep project context discoverable
Setup
Build it in a few focused steps.
- 1Connect GitHub and Codacy to Notis once through the portal.
- 2Create an automation in the portal or ask Notis conversationally.
- 3Use this instruction: When the monitored GitHub README changes, list Codacy projects and report the likely project for the repository with the README link.
- 4Select the README changed trigger, choose a run-report channel, and test with one real README update.
Questions about this workflow
Can this monitor a README in a specific directory?
Yes. Configure the repository directory and branch or reference in the trigger.
Why connect documentation to Codacy?
It gives maintenance changes a consistent quality-workspace reference.
When this happens · Trigger
Do this · Action
Supported Triggers and Actions
Notis builds workflows that link GitHub to Codacy. A trigger fires from one place; an action lands in another.
GitHub triggers
Codacy actions
Recurring trigger
Notis starts this workflow on a schedule, such as daily, weekly, or during business hours.
Create API Token
Tool to create a new api token for the authenticated user's account. use after authenticating when you need to generate a fresh token for integrations.
Webhook trigger
Notis starts this workflow when an external tool or custom backend sends an HTTP request.
Delete API Token
Tool to delete a specific api token from the authenticated user's account. use after confirming the token id.
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.
Get Account Details
Tool to retrieve details of the authenticated user's account. use when confirming authentication before user-level operations.
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.
Get Organization Repositories
Tool to list all repositories under a specific organization and provider. use when you need to enumerate organization-scoped repositories.
New Branch Created
Triggers when a new branch is created in a GitHub repository. Detects newly created branches. Deleted branches do not fire events.
Get User Organizations
Tool to list all organizations the authenticated user belongs to. use after authenticating and need to discover accessible organizations.
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.
List Projects
Tool to list all projects accessible to the authenticated user. use when you need a list of repositories after confirming api token validity.
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.
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 Codacy, 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 Codacy.