GitHub links

Use Cases

The Use Cases section shows how teams are using GitHub Links for Confluence in practice - from writing technical documentation to running sprint retrospectives and documenting releases.

Each page focuses on a specific workflow and includes the relevant GitHub URL patterns, macro configuration tips, and example page structures.

Use case

What it covers

Writing informative technical Confluence documentation with GitHub data

Embedding source files, gists, commits, compare views, and discussions in technical docs

Preparing sprint retrospectives

Embedding PRs, issues, milestones, commits, and security alerts in retro pages, plus using the reporting macros

Documenting release details

Embedding releases, tags, compare views, and commits in release notes and changelogs

Engineering QBR / Stakeholder page

Running a live QBR or stakeholder update with real-time delivery metrics from the Reporting Macros


Updated: