Confluence integration

Make sure every code change follows the requirements and guidance recorded in your Confluence pages.

circle-info

Note: The Confluence integration is available only on the Enterprise Planarrow-up-right.

Bito integrates with Confluence to enhance functional validation by enriching pull request requirements with deeper context from linked documentation.

It fetches relevant details from Confluence pages linked in Jira issues or directly in pull request – such as edge cases, design decisions, or test scenarios – and incorporates them into structured validation results.

This improves accuracy when validating code changes and ensures that every pull request is aligned with the requirements.

How it works

When a pull request is opened, Bito automatically:

  1. Detects Confluence references. Bito looks for Confluence page links in the pull request description or in any linked Jira issues.

circle-info

Note: If Jira integration is enabled, Bito finds the Confluence pages associated with the linked Jira tickets.

  1. Fetches documentation. Bito retrieves the content of those Confluence pages and extracts key information (requirements, design decisions, acceptance criteria, etc.).

  2. Validates code against the docs. It compares your code changes to the enriched context and generates structured validation feedback.

  3. Reports results in the PR. Bito posts a "Functional Validation" table directly in your pull request comments, showing how each documented requirement is met, missed, or partially implemented.

Integration steps

1

Connect Bito with Confluence

  1. In your Bito dashboard, go to the Manage integrationsarrow-up-right page.

  2. Under Available integrations, find Confluence and click Connect.

  3. Click Authorize with your Confluence account. You will be redirected to Atlassian's site to grant Bito access to your Confluence workspace. This uses OAuth to securely link your Confluence content.

  4. Sign in to your Atlassian account if prompted, then click Accept. After successful authorization, you will be returned to Bito.

2

Agent-specific settings

After completing the initial setup, you can control Confluence integration on a per-agent basis:

  1. Go to the Repositoriesarrow-up-right page in your Bito dashboard.

  2. Find the Agent instance you want to connect with Confluence and open its settings.

  3. Within the Agent settings screen, click on the Functional validation tab.

  4. Locate the Functional validation option and enable it to enhance pull request validation by incorporating relevant context from linked Confluence pages.

circle-info

Note: The Functional validation feature must be enabled in your Bito agent settings for the integration to work.

Linking Confluence pages to pull requests

For Bito to fetch the right documentation, your pull requests must reference the relevant Confluence pages:

  • With Jira integration: Ensure your Jira issues link to the Confluence pages (for example, by using the Jira Issue macro on the Confluence page). When a Confluence page mentions a Jira issue key, Jira automatically creates a link to that page. Bito will follow those links to gather the documentation context.

  • Without Jira integration: Include a link to the Confluence page directly in the pull request description. Bito will use that URL to retrieve the page content for validation.

circle-info

Note: Currently, Bito supports only full, direct Confluence page URLs that include the page ID. Short Confluence URLs are not supported at this time.

Supported example: https://yourcompany.atlassian.net/wiki/spaces/SPACEKEY/pages/123456789/Page-Title

Not supported example: https://yourcompany.atlassian.net/wiki/x/AbCdE

Understanding the validation results

When Bito completes its analysis, it adds a "Functional Validation by Bito" table to your pull request comments. This table contains four columns:

Source

Displays the Jira issue key (e.g., "QP-11", "QP-123") that references the specific Jira ticket being validated.

Requirement / Code Area

Shows a brief description of the requirement or task that needs to be completed, summarizing what needs to be done according to the Jira ticket and Confluence page.

Status

Indicates the completion status of each requirement:

  • Met: The requirement has been fully implemented in the pull request

  • Missed: The requirement has not been addressed in the pull request

  • Partial: The requirement has been partially implemented but still needs additional work

  • Conflict: A change contradicts another requirement (e.g., two requirements cannot both be satisfied by the current code).

  • Out‑of‑scope: The change is not in the requirements (the code change does not relate to any defined requirement).

Notes

Provides detailed information about the validation status:

  • For "Met" items: Explains what has been successfully implemented

  • For "Missed" items: Describes what is missing and needs to be addressed

  • For "Partial" items: Details what has been completed and what still remains to be done

  • For "Conflict" items: Describes why there is a contradiction between requirements and what might need to be resolved.

  • For "Out‑of‑scope" items: Explains why the change is considered outside the defined requirements.

Example validation output

Here's what a typical validation table looks like:

Benefits

  • Improved traceability: Syncing code validation with Confluence documentation creates a clear audit trail from requirements to implementation.

  • Single source of truth: By pulling from Confluence (the team’s central documentation hub), Bito ensures developers review code against the definitive requirements. Teams spend less time context-switching between tools.

  • Aligned development: Automatic validation against documented scenarios helps catch missing features or edge cases early, reducing manual review effort and improving quality.

Troubleshooting

  • No "Functional validation" table in pull request: Check that Confluence is connected under Manage integrationsarrow-up-right and that the Functional Validation setting is enabled for your Agent. Also verify that your PR or its linked Jira issues actually reference the Confluence pages.

  • Missing or incorrect context: Make sure the Confluence pages contain the up-to-date requirements or test scenarios.

  • Authorization errors: If Bito can't access Confluence, try re-authorizing the integration. Ensure your Atlassian account has permission to read the relevant Confluence pages.

Last updated