Skip to content

BP-2638: Jira integration#321

Open
jeff-matthews wants to merge 3 commits into
mainfrom
BP-2638-jira-forge
Open

BP-2638: Jira integration#321
jeff-matthews wants to merge 3 commits into
mainfrom
BP-2638-jira-forge

Conversation

@jeff-matthews

@jeff-matthews jeff-matthews commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added comprehensive Atlassian Jira integration documentation covering setup, configuration, usage workflows, troubleshooting, and technical reference for syncing BloodHound findings to Jira Cloud.
    • Updated integration overview page with new Jira integration card and Google SecOps improvements.

Staging

@jeff-matthews jeff-matthews self-assigned this Jun 23, 2026
@jeff-matthews jeff-matthews added the integrations Docs related to integrations with third-party platforms label Jun 23, 2026
@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
bloodhound 🟢 Ready View Preview Jun 23, 2026, 6:29 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@jeff-matthews, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 53 minutes and 7 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 213c3305-bfef-4236-b79d-1b661d8a4154

📥 Commits

Reviewing files that changed from the base of the PR and between 9c1d46e and 28fbc14.

📒 Files selected for processing (1)
  • docs/integrations/overview.mdx

Walkthrough

Adds four new MDX documentation pages for the BloodHound Enterprise Atlassian Jira integration: configure, use, troubleshoot, and reference. Registers the Atlassian/Jira navigation group in docs.json and adds a Jira integration card to docs/integrations/overview.mdx, including a minor wording update to the Google SecOps card.

Changes

Jira Integration Documentation

Layer / File(s) Summary
Navigation registration and integrations overview card
docs/docs.json, docs/integrations/overview.mdx
Inserts the AtlassianJira navigation group into the API & Integrations tab with four linked pages. Adds a Jira card to the supported integrations overview and updates wording in the Google SecOps card.
Configure page: installation, connection, and sync settings
docs/integrations/atlassian/jira/configure.mdx
New page covering prerequisites, Marketplace installation, connection settings (domain, token ID/key, required connection test), synchronization settings (issue model, scope selection, priority/due-date mapping, auto-closure), and post-configuration verification with next-step links.
Use page: issue model, format, sync behavior, and workflows
docs/integrations/atlassian/jira/use.mdx
New page documenting how BHE findings map to Jira issues/incidents, the structured issue format (summary, description, labels, dates, priority), periodic sync behavior, duplicate prevention, and suggested triage workflows.
Troubleshoot page: failure scenarios and error messages
docs/integrations/atlassian/jira/troubleshoot.mdx
New page with sections covering connection test failures, locked configuration tab, missing issue creation, incorrect priority/due dates, auto-closure failures, missing JSM request types, and a common configuration error message table.
Reference page: architecture, auth, sync model, and API dependencies
docs/integrations/atlassian/jira/reference.mdx
New page documenting the Forge-based architecture, HMAC authentication and OAuth scopes, user-configurable inputs, Jira Software vs. JSM behavior differences, sync/cleanup cadence, required issue content fields, dependent BHE API endpoints, and centralized error-handling behavior.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Suggested reviewers

  • computator
  • Scoubi
  • rtippitt-specterops

Poem

🐇 Hippity-hoppity, docs are in place,
Jira and BHE now interface!
Configure, use, troubleshoot, reference too —
Four shiny new pages, all sparkling and new.
The rabbit's so pleased with this tidy new stack,
No orphaned findings shall ever come back! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'BP-2638: Jira integration' directly and clearly summarizes the main change: adding documentation for a new Jira integration to BloodHound Enterprise.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch BP-2638-jira-forge

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
docs/integrations/atlassian/jira/troubleshoot.mdx (1)

53-62: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Optional style improvement: Consider more formal verb phrasing.

Line 57 uses "To correct the issue." For consistency with formal documentation tone, consider rephrasing to "To resolve the issue" or "To fix the issue," which may align better with the broader documentation style.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/integrations/atlassian/jira/troubleshoot.mdx` around lines 53 - 62, The
introductory phrase "To correct the issue" uses informal language that doesn't
align with formal documentation tone. Replace "To correct the issue" with "To
resolve the issue" or "To fix the issue" in the troubleshooting section for the
"Jira uses the wrong priority or due date" heading to maintain consistency with
the broader documentation style guide.

Source: Linters/SAST tools

docs/integrations/atlassian/jira/reference.mdx (1)

144-144: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Minor wording improvement on line 144.

"The integration calls for centralized API error handling" is awkward phrasing. Consider: "The integration implements centralized API error handling" or "uses centralized API error handling."

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/integrations/atlassian/jira/reference.mdx` at line 144, The phrase
"calls for centralized API error handling" on line 144 is awkward phrasing.
Replace "calls for" with a more direct verb such as "implements" or "uses" to
improve clarity. The sentence should read "The integration implements
centralized API error handling with logging and graceful recovery when possible"
or similar variation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/integrations/overview.mdx`:
- Around line 90-93: The Jira Card component has an incorrect href attribute
that points to `/integrations/jira/forge/configure` instead of the correct
registered docs path. Update the href attribute in the Card component with
title="Jira" to use `/integrations/atlassian/jira/configure` to match the
correct documentation path already used elsewhere in the file and ensure the
link target is consistent and functional.

---

Nitpick comments:
In `@docs/integrations/atlassian/jira/reference.mdx`:
- Line 144: The phrase "calls for centralized API error handling" on line 144 is
awkward phrasing. Replace "calls for" with a more direct verb such as
"implements" or "uses" to improve clarity. The sentence should read "The
integration implements centralized API error handling with logging and graceful
recovery when possible" or similar variation.

In `@docs/integrations/atlassian/jira/troubleshoot.mdx`:
- Around line 53-62: The introductory phrase "To correct the issue" uses
informal language that doesn't align with formal documentation tone. Replace "To
correct the issue" with "To resolve the issue" or "To fix the issue" in the
troubleshooting section for the "Jira uses the wrong priority or due date"
heading to maintain consistency with the broader documentation style guide.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9609f5de-6030-4ee8-abb3-da8ae9d1ff37

📥 Commits

Reviewing files that changed from the base of the PR and between 10103aa and 9c1d46e.

📒 Files selected for processing (6)
  • docs/docs.json
  • docs/integrations/atlassian/jira/configure.mdx
  • docs/integrations/atlassian/jira/reference.mdx
  • docs/integrations/atlassian/jira/troubleshoot.mdx
  • docs/integrations/atlassian/jira/use.mdx
  • docs/integrations/overview.mdx

Comment thread docs/integrations/overview.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integrations Docs related to integrations with third-party platforms

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant