GitHub links
GitHub links
Breadcrumbs

How to create a GitHub links macro in Confluence Data Center?

Get to know the easiest way to create a GitHub link macro.

GitHub links for Confluence (Data Center) provide link recognition of the GitHub public and private pull requests and issues. Gain better visibility and traceability of important issues and milestones with embedded GitHub data.

Confluence GitHub integration is realised with GitHub links macro help.

There are two ways to create GitHub macro links.

  1. When editing your confluence page, click drop down image-20240517-081258.png then select “Other macros” as shown below:

image-20240517-081327.png


This will bring up the “Select Macro” window. From here, search for GitHub Links” as shown below and select it:

image-20240517-081410.png

  1. For the second option, when editing your confluence page, type {github where you like the link to be pasted and select “GitHub Links” from the “Macro suggestions” pop up as shown below:

image-20240517-081507.png


Either of the two options will bring you to the following window:

image-20240517-081555.png


Enter the URL or the issues or pull requests, this can be individual issues/pull requests or full directories, which will then be populated. The image-20240517-081710.png button will show the populated data prior to inserting it.

image-20240517-081745.png

The GitHub links macro will show the status and any labels assigned within your GitHub repositories.

image-20240517-081816.png

GitHub links can also be used in page comments.

image-20240517-081849.png

Creating a GitHub Links Macro for all pull requests or issues in a repository, ensures any new items added, will be automatically added to your Confluence page providing a convenient overview with a simple page refresh.


Updated: