Skip to content

docs: Clarify auto-merge is only available for commit triggers #233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
promptless wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Clarify auto-merge is only available for commit triggers #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e9cdc0
Clarify auto-merge is only available for commit triggers
promptless[bot] Feb 2, 2026
15fecc8
Sync documentation updates
promptless[bot] Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion fern/docs/configuration/doc-collections/github-repos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ When auto-publish is enabled for your project:

- Promptless automatically creates a new PR in your documentation repository with suggested changes
- For GitHub PR triggers, the documentation PR is linked in a comment on the original code PR
- Optionally enable auto-merge to automatically merge documentation PRs as soon as they're created (nested checkbox under auto-publish in project settings)
- For [commit triggers](/docs/configuration/triggers/github-commits), you can enable auto-merge to automatically merge documentation PRs as soon as they're created (nested checkbox under auto-publish in project settings)

## Automated CI Check and Build Issue Resolution

Expand Down
2 changes: 1 addition & 1 deletion fern/docs/configuration/triggers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Need a trigger type that isn't currently supported? Contact us at [help@goprompt

## Auto-publish Mode

When auto-publish is enabled for your project, Promptless automatically creates pull requests in your documentation repository with suggested changes. You can optionally enable auto-merge to automatically merge documentation PRs as soon as they're created.
When auto-publish is enabled for your project, Promptless automatically creates pull requests in your documentation repository with suggested changes. For [commit triggers](/docs/configuration/triggers/github-commits), you can optionally enable auto-merge to automatically merge documentation PRs as soon as they're created.

Auto-publish is available for GitHub-based documentation platforms. For CMS platforms like Zendesk or Intercom, documentation updates are created as drafts for review.

Expand Down
17 changes: 17 additions & 0 deletions fern/docs/configuration/triggers/github-commits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,23 @@ GitHub commit triggers are especially useful for:
- **Direct-to-Main Workflows**: Support teams that commit directly to main branches
- **Automated Updates**: Trigger documentation updates from automated commit processes

## Auto-merge Mode
Copy link
Contributor Author

@promptless promptless bot Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #1932 restricts auto-merge option to only be shown for github_commit trigger types in EditProjectModal.tsx and NewProjectModal.tsx. The UI now conditionally renders the auto-merge checkbox with {editedProject.trigger_type === 'github_commit' && (...)}.
View source


Automatically merge documentation PRs into the default branch as soon as they're created.

Auto-merge requires auto-publish to also be enabled.

Auto-merge is useful for:
- **Internal documentation**: When documentation PRs don't require human review
- **High-confidence workflows**: Teams that want full automation
- **Changelog-driven updates**: When you want changelog updates to publish immediately

Enable auto-merge in your [project settings](https://app.gopromptless.ai/projects) by checking "Automatically merge Promptless suggestions into the default branch." This option is only available for commit triggers.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/project-settings-auto-merge-86d6c89f.png" alt="Project settings showing auto-publish and auto-merge checkboxes" />
</Frame>

## Setup Instructions

To connect GitHub to Promptless, see the [GitHub Integration](/docs/integrations/github-integration) setup guide.
1 change: 0 additions & 1 deletion fern/docs/configuration/triggers/github-prs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ Learn more about GitHub repository topics in the [GitHub documentation](https://
When auto-publish is enabled for your project:
Copy link
Contributor Author

@promptless promptless bot Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #1932 removes auto-merge as an option for PR triggers - the auto_merge flag is now automatically set to false when switching to non-commit trigger types.
View source

- Promptless automatically creates a new PR in your documentation repository with suggested changes
- The documentation PR is linked in a comment on the original code PR
- Optionally enable auto-merge to automatically merge documentation PRs as soon as they're created

## Draft Pull Requests

Expand Down