Skip to content

docs: Document GitHub Commit trigger feature #160

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 1 commit into
base: main
Choose a base branch
from
Open

docs: Document GitHub Commit trigger feature #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 2 additions & 4 deletions fern/docs/changelogs/2025-11.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: November 2025

**What's New:**

* **GitHub Commit Triggers:** Promptless now runs on direct commits to your default branch—perfect for teams that skip pull requests. Select "GitHub Commit" when creating or editing a project, choose your repository, and Promptless analyzes commits to your default branch just like it does for PRs. Commits from PRs we already processed are automatically skipped.

* **Rich Slack Notifications for Quick Review and Publishing:** When Promptless creates documentation suggestions, you get rich notifications in Slack showing the suggestion title, description, assigned team members, trigger source, and files changed. Use the "Publish" button to merge small, straightforward suggestions directly from Slack, or click "Open PR" to review changes in detail on GitHub or in the Promptless dashboard.

<Frame>
Expand All @@ -15,7 +17,3 @@ title: November 2025
<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/new-task-attachments-november-2025-1762900503.png" alt="New Task dialog showing attachment support with Add files button" />
</Frame>

* **Automatic CI Fixes:** When documentation PRs from Promptless fail CI checks or build tests, Promptless automatically detects the issue and pushes a fix. No manual intervention needed for build errors.

* **GitHub Enterprise Context Search:** Promptless now searches through your GitHub Enterprise issues, pull requests, and discussions when creating documentation suggestions—bringing GitHub Enterprise customers the same context gathering capabilities as GitHub Cloud users.
14 changes: 12 additions & 2 deletions fern/docs/core-concepts/triggers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Triggers are events that initiate automated documentation updates in Promptless.

<CardGroup cols={2}>
<Card title="GitHub/Bitbucket/GitLab" icon="fa-code-pull-request">
Automatically triggered when PRs/MRs are opened in your source repositories
Automatically triggered when PRs/MRs are opened or commits are pushed to your source repositories
</Card>

<Card title="Slack Integration" icon="brands slack">
Expand All @@ -16,13 +16,23 @@ Triggers are events that initiate automated documentation updates in Promptless.

### GitHub / Bitbucket / GitLab

Promptless automatically monitors your specified source repositories for new pull requests. When a PR/MR is opened, the system analyzes the changes to determine if documentation updates are needed.
Promptless automatically monitors your specified source repositories for new pull requests or direct commits. When a PR/MR is opened or a commit is pushed to your default branch, the system analyzes the changes to determine if documentation updates are needed.

During analysis, Promptless processes information such as the code diff, PR title, and PR description to understand the context and scope of changes. This information is used solely for generating documentation suggestions and is not stored by Promptless.

You can configure specific directories to monitor, focusing documentation efforts on relevant parts of your codebase.

<AccordionGroup>
<Accordion title="GitHub Commit Triggers">
In addition to monitoring pull requests, GitHub can be configured to trigger on direct commits to your default branch. This is useful for teams that commit directly to main/master without using pull requests.

When you create or edit a project, select "GitHub Commit" as your trigger type and choose which repository to monitor. Promptless will analyze commits to your default branch and automatically skip commits that originated from pull requests we already processed.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/github-commit-trigger-project-config.png" alt="GitHub Commit trigger project configuration showing branch monitoring" />
</Frame>
</Accordion>

<Accordion title="Auto-publish Mode">
When auto-publish is enabled for your project:
- Promptless automatically creates a new PR with suggested documentation changes
Expand Down
2 changes: 1 addition & 1 deletion fern/docs/integrations/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Used for: Triggers, Context, and Publishing**

Promptless integrates with GitHub through our official GitHub App, providing secure access to your repositories for documentation automation.
Promptless integrates with GitHub through our official GitHub App, providing secure access to your repositories for documentation automation. You can trigger documentation updates from pull requests or direct commits to your default branch.

<Info>
**GitHub Enterprise Users**: If you're using GitHub Enterprise Server or GitHub Enterprise Cloud with restricted third-party app access, see our [GitHub Enterprise Setup Guide](/docs/integrations/github-enterprise-integration) for custom GitHub App configuration instructions.
Expand Down