GitHub links

GitHub Links for Confluence Cloud Guides

GitHub Links for Confluence brings your GitHub work directly into your Confluence pages. Embed live GitHub content - pull requests, issues, commits, files, branches, and more - so your documentation always reflects what is happening in your repositories.

With Engineering Reporting, the app now also renders team-level GitHub delivery metrics live on your pages: PR Cycle Time, PR Throughput, and Review Latency. Whether you are writing runbooks, planning docs, or a quarterly engineering review, you can now show both the work and the delivery signals in one place - without leaving Confluence.

Reporting is included in the app at your standard subscription, reuses your existing GitHub connection, and stores no code or PR data.

Guide

Who it is for

Getting Started Guide for Confluence Administrators

Administrators connecting the GitHub App to Confluence for the first time

Getting Started Guide for Confluence Users

Anyone who wants to start embedding GitHub links on Confluence pages

Connecting and disconnecting GitHub links

Administrators who need to change or remove the GitHub App connection

Adding GitHub link macros to a Confluence page

Anyone adding a GitHub link to a page for the first time

GitHub Links macro - configuration options

Anyone customising how a GitHub link is displayed or filtered

Supported GitHub link types

Reference - full list of supported URL patterns and what each card displays

GitHub Enterprise Cloud support

Teams using GitHub Enterprise Cloud (*.ghe.com)

Working with Discussions

Teams who want to embed GitHub Discussions

Working with Security alerts

Teams who want to embed Dependabot, Code Scanning, or Security Advisory alerts

Linking Source File Segments

Anyone embedding a specific line range from a source file

Managing GitHub App permissions and organisation access

Administrators managing repository access or granting permissions for optional features

Reporting Macros

Teams who want live PR metrics and trend charts on Confluence pages

Going further

Use Cases

Real-world examples of GitHub Links for Confluence in practice - sprint retrospectives, release documentation, and technical documentation

GitHub links for Confluence: Cloud and Data Center Comparison

A full feature comparison between the Cloud and Data Center versions of the app