Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions fern/docs/configuration/triggers/github-commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,26 @@ When a commit is pushed directly to a monitored branch:
3. **Relevance Assessment**: Promptless determines if the changes require documentation updates
4. **Suggestion Creation**: If relevant, Promptless creates documentation suggestions

## Commit Triggers vs. Pull Request Triggers
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: Based on prithvi's explanation of the two approaches: (1) commits + PRs for getting PR comments plus updated suggestions after merge, or (2) commits only for teams who find PR triggers too noisy. When using commits only, you won't get PR comments so a Slack notification channel is recommended.
View source


You can use GitHub commit triggers alongside PR triggers, or as a standalone approach.

### Use commits alongside PR triggers

If you configure both a GitHub PR project and a GitHub Commits project for the same repositories:

- Promptless comments on PRs while they're open, providing early feedback on documentation needs
- After the PR merges, the commit trigger updates suggestions with the final merged content
- Useful when you want PR comments during review and updated suggestions after merge

### Use commits only

If you configure only a GitHub Commits project, without a corresponding PR project:

- Promptless only runs after changes merge to your default branch
- Reduces notification noise if PR triggers are too frequent
- Since you won't get PR comments, configure a Slack notification channel to stay informed about new suggestions

## Configuration

Configure GitHub commit triggers in your [project settings](https://app.gopromptless.ai/projects):
Expand All @@ -27,6 +47,21 @@ Configure GitHub commit triggers in your [project settings](https://app.goprompt
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/47a14116-12d1-4a1d-beae-875c1d182124-github-directory-trigger.png" alt="GitHub commit trigger configuration showing directory options" />
</Frame>

## Notification Channels

Since commit triggers don't create PR comments, we recommend configuring a Slack notification channel. Promptless posts to this channel whenever it creates or updates suggestions based on commits.

To configure a notification channel:

1. Go to your [project settings](https://app.gopromptless.ai/projects)
2. Click the pencil icon to edit your GitHub Commits project
3. Add your preferred Slack channel at the bottom of the project settings
4. Save your changes

<Note>
If you're using a private Slack channel, you'll need to add Promptless to that channel first. Tag `@Promptless` in the channel to prompt Slack to invite the app.
</Note>

## Directory-Specific Commits

Similar to PR triggers, you can configure Promptless to only trigger on commits that affect specific directories. This is particularly useful for monitoring changelog directories or specific feature areas.
Expand Down
12 changes: 11 additions & 1 deletion fern/docs/integrations/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,16 @@ Once connected, you can use Slack for:

## Privacy and Channel Access

By default, Promptless only reads Slack content when you explicitly trigger it by tagging @Promptless or using the "Update Docs" message action. If you enable passive listening in your project settings, Promptless will monitor only the specific channels you select. Promptless cannot access private channels unless it has been specifically invited to those channels.
By default, Promptless only reads Slack content when you explicitly trigger it by tagging @Promptless or using the "Update Docs" message action. If you enable passive listening in your project settings, Promptless will monitor only the specific channels you select.

### Adding Promptless to Private Channels
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Citation: Based on prithvi's advice that if a notification channel is private, you need to add Promptless to it first—the easiest way is to tag @promptless in that channel.
View source


Promptless cannot access private channels unless it has been specifically invited. To add Promptless to a private channel, tag `@Promptless` in that channel—Slack will prompt you to invite the app.

This is required if you want to:

- Use a private channel as your notification channel for suggestions
- Trigger Promptless from messages in a private channel
- Enable passive listening on a private channel

For more details about using Slack with Promptless, see [Working with Slack](/docs/features/slack-interactions).