Exporting retrospectives to Confluence

Prerequisites

If you haven't already, configure your Confluence integration.

Setup Runbook Step

Exporting retrospectives out to Confluence can be automated via Runbook step.

  1. From a Runbook edit screen, click on Add Step at the bottom.

  2. In the dialog, find or search for "Confluence" and select Export Retrospective to Confluence.

    Export Retrospective to Confluence runbook step
    Export Retrospective to Confluence runbook step
  3. FireHydrant provides default templating, but you can optionally customize the content. The template fields support Liquid templating variables.

    • Parent Page: This refers to the main page that the new Confluence page will be created within. Leave empty to save at the top level in your Confluence workspace.
    • Title Template: This is the name of the new Confluence page that will be created
    • Body Template: This is the body of the page that we will create in Confluence. This field also accepts variables, so you can automatically include details such as when the incident started, the incident summary, severity, roles involved, and much more.
  4. On the Conditions & scheduling tab, make sure settings are configured per your requirements.

    • Keep in mind that for this step to successfully execute, the step must run after the Retrospective has at least started. Valid conditions include:
      • When Current milestone is Retrospective Started
      • When Current milestone is Retrospective Completed
      • Time since Retrospective/Retrospective Completed
      • Execute manually
  5. When you are finished configuring the step, click Add Step and then Save Runbook.

Runbook Execution

Upon export, it may take a few minutes for the retrospective export to render in Confluence. Once the export is complete, a link to the exported document will appear on the Retrospective's Incident Overview tab.

Links in the retrospective
Links in the retrospective

Note: This step will only be able to execute once, even if included in multiple Runbooks. Subsequent executions after the first will fail.

Troubleshooting

Atlassian converting ADF to storage format error

The Atlassian Confluence API occasionally returns the following error when a Confluence runbook export is initiated:

Confluence ADF conversion error
Confluence ADF conversion error

This intermittent error has been reported on the Confluence developer forum. If this happens, try clicking Retry Step by opening the Runbooks step details from the Retrospective's Incident overview page.

Runbook step details in Retrospective
Runbook step details in Retrospective

Last updated on 2/9/2024