Configuring Github Macros for Confluence (Server)

Owned by Gabriela Costa
Last updated: Mar 01, 2024 by Smita Nair
2 min read

Support for Atlassian Server Products is ending in February 2024. Consider migrating to Github Macros for Confluence’s Data Center version.

Or, are you planning to migrate to Cloud? Make sure you do not lose your data/configurations in the process. Check out the Migration guide for information on how to migrate the app’s data to Cloud. Contact our support team if you have any questions.

Macro to include code snippets, files, issues and more from Github into Confluence

Features

  • Include and render markdown files from Github into Confluence.
  • Include issue lists from Github into Confluence.
  • Include pull request lists from Github into Confluence.
  • Support for both private and public repositories.

Configuration

Once a Github token is configured, all confluence users will have access to it when using the macros. This means that contents of private repositories will be accessible to all Confluence users.

 

If enabled, macro use tokens with Github API to render private images and links in Markdown from your private Github repositories. Note, that Github has a limit for API calls, so if your page with Github Macro has thousands of views, you may exceed the hourly API call limit of your token.

Register new personal access token

You will need a personal access token from Github to configure the plugin for server. Create a personal access token here.

Once you have obtained a personal access token click the Add new token button on the plugin configuration page. 

A configuration dialog appears. Enter your username and personal access token here. If you are using Github Enterprise, you can also add the optional URL for your own Github server. Once you are done, click Add.


Limit the number of lines (Optional)

If you want to display only certain lines of code, specify the limit of the code lines to be displayed. Leave this parameter blank to display complete code lines.  Or, you can specify range or number of maximum lines to be displayed. For example: 5, 2-25.

  • This parameter is applicable only for GitHub file macro. 
  • The global configuration parameter Limit the number of Lines is the default value for the macro parameter Lines of code of a new macro.
  • You can specify the Lines of code macro parameter within each macro, and this takes precedence over the Limit the number of Lines specified in the global configuration.
  • You can hide the line numbers displayed in code block. To hide the line numbers, go to the GitHub file macro and select the Hide line numbers of code block checkbox.

You are now ready to get started with the macro!

Refer to the Macros page to learn more about the macros.