Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

docs: Update Bitbucket Integration Documentation for Enhanced Publishing Workflow #154

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
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
12 changes: 12 additions & 0 deletions docs/changelogs/2025-05.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# May 2025

## New Features

### Enhanced Bitbucket Publishing Workflow
- **Direct Publishing**: Added "Save All & Update Bitbucket" button in the Change History page for seamless documentation repository updates
- **Automatic Commit Management**: Support for both direct commits and pull request creation for documentation changes
- **Branch Strategy Configuration**: Enhanced branch management with options for main branch commits or feature branch creation
- **Real-time Feedback**: Publishing progress indicators and success/error messaging for better user experience
- **Auto-Publish Support**: Streamlined workflows with automatic documentation commits and configurable review processes

This enhancement makes the Bitbucket integration more practical for day-to-day documentation workflows by enabling direct publishing to documentation repositories without manual intervention.
32 changes: 31 additions & 1 deletion docs/integrations/bitbucket.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,35 @@ To set up directory-specific triggers:
2. Under **Advanced Options**, enable **Directory-Specific Triggers**
3. Enter the directories you want to monitor, separated by commas (e.g., `src/api, docs/reference`)

## Publishing Workflow

When Promptless creates or updates documentation for your Bitbucket-hosted repositories:

1. Documentation changes are prepared based on your triggers and context sources
2. Review the suggested changes in the Change History page
3. Click **"Save All & Update Bitbucket"** to publish directly to your documentation repository
4. Changes are automatically committed to the specified branch in your Bitbucket repository
5. View the published changes in your Bitbucket repository and documentation site

### Publishing from Change History

The Change History page provides a streamlined publishing experience for Bitbucket repositories:

- **Direct Publishing**: Use the "Save All & Update Bitbucket" button to commit all changes at once
- **Branch Management**: Automatically create pull requests or commit directly to your documentation branch
- **Real-time Updates**: See publishing progress with loading indicators and commit status
- **Success Confirmation**: Receive confirmation when changes are successfully committed to Bitbucket
- **Error Handling**: Get clear error messages if publishing encounters repository access issues

### Auto-Publish Configuration

For streamlined workflows, you can enable auto-publish functionality:

- **Automatic Commits**: Documentation updates are automatically committed to your repository
- **PR Creation**: Optionally create pull requests for documentation changes that require review
- **Branch Strategy**: Configure whether to commit to main branch or create feature branches
- **Commit Messages**: Automatic generation of descriptive commit messages with trigger context

## Authentication Model

The Bitbucket integration uses a username and app password authentication model:
Expand Down Expand Up @@ -83,12 +112,13 @@ Promptless automatically sets up webhooks in your Bitbucket repositories to moni

## Usage

Once configured, the Bitbucket integration works similarly to the GitHub integration:
Once configured, the Bitbucket integration works to automate your documentation workflow:

1. When a pull request is opened or updated in your monitored repositories, Promptless is automatically triggered
2. Promptless analyzes the changes to determine if documentation updates are needed
3. If updates are needed, Promptless generates the appropriate documentation changes
4. Promptless adds a comment to your Bitbucket pull request with a link to review the documentation changes
5. You can review and approve the suggested documentation updates in the Promptless dashboard
6. Use the Change History page to publish approved changes directly to your documentation repository

For more information on how triggers work in general, see the [Triggers](/core-concepts/triggers) documentation.