From 85e2b0d3e3ea1f22df8170fa702860978ee0a7bf Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Tue, 25 Nov 2025 19:43:25 +0000 Subject: [PATCH] Document GitHub Commit trigger feature --- fern/docs/changelogs/2025-11.md | 6 ++---- fern/docs/core-concepts/triggers.md | 14 ++++++++++++-- fern/docs/integrations/github.mdx | 2 +- 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/fern/docs/changelogs/2025-11.md b/fern/docs/changelogs/2025-11.md index 11fa2ed..95170d9 100644 --- a/fern/docs/changelogs/2025-11.md +++ b/fern/docs/changelogs/2025-11.md @@ -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. @@ -15,7 +17,3 @@ title: November 2025 New Task dialog showing attachment support with Add files button - -* **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. diff --git a/fern/docs/core-concepts/triggers.md b/fern/docs/core-concepts/triggers.md index 1e98f8b..d363a80 100644 --- a/fern/docs/core-concepts/triggers.md +++ b/fern/docs/core-concepts/triggers.md @@ -6,7 +6,7 @@ Triggers are events that initiate automated documentation updates in Promptless. - 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 @@ -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. + + 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. + + + GitHub Commit trigger project configuration showing branch monitoring + + + When auto-publish is enabled for your project: - Promptless automatically creates a new PR with suggested documentation changes diff --git a/fern/docs/integrations/github.mdx b/fern/docs/integrations/github.mdx index 5da5d8e..5a4e814 100644 --- a/fern/docs/integrations/github.mdx +++ b/fern/docs/integrations/github.mdx @@ -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. **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.