Skip to content

docs: clarify how workflow triggers and prompts interact#5899

Closed
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/77bac21d
Closed

docs: clarify how workflow triggers and prompts interact#5899
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/77bac21d

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 22, 2026

Summary

Adds a short subsection to the Workflows overview explaining that triggers fire unconditionally and that conditional "should I update docs?" logic belongs in the prompt.

Changes

  • Added a "How triggers and prompts work together" subsection under Trigger types in workflows/index.mdx.
  • Notes that push triggers do not filter by changed paths and schedule triggers run on every occurrence.
  • Recommends shifting to a schedule trigger to reduce run frequency and pointing prompt logic at no-op cases.

Context

Recurring assistant questions in the last week asked whether workflows could "only run when a doc change is needed," whether push triggers filter by path, and how schedule triggers affect run volume. The overview previously listed the two trigger types without explaining the trigger-vs-prompt division of responsibility.


Note

Low Risk
Low risk documentation-only change that clarifies workflow behavior and guidance without affecting runtime logic.

Overview
Adds a new "How triggers and prompts work together" section to the Workflows overview to clarify that triggers run on every qualifying push/schedule occurrence (no path filtering or pre-flight skip) and that conditional/no-op decision-making should be implemented in the workflow prompt.

Also advises switching from push-based triggers to scheduled runs to reduce run frequency, with a note that failed runs don’t count toward usage limits.

Reviewed by Cursor Bugbot for commit 9eb48ee. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 22, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 22, 2026, 4:15 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 22, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
testsignup415 🟢 Ready View Preview May 22, 2026, 4:15 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants