Configuring Github Macros for Confluence (Server)
Macro to include code snippets, files, issues and more from Github into Confluence
- 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.
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 will 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 hourly API call limit of your token.
Register new personal access token
You'll need a personal access token from Github to configure the plugin for server. Create a personal access token here.
Once you've obtained a personal access token click the Add new token button on the plugin configuration page.
You'll be presented with a configuration dialog. Enter your username and personal access token here. If you're using Github Enterprise, you can also add the optional URL for your own Github server. Once you're done click the Add button.
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. You can specify range or number of maximum lines to be displayed. For example: 5, 2-25.
Leave this parameter blank to display complete code lines.
- 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 will take 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 go to GitHub file macro and select the Hide line numbers of code block checkbox.
- Github Pull Request List
- GIthub Issue List
- Github Markdown File
- Github File Content
Here is an example of the Github Pull Request List macro filled out. We used a public repository so you can copy the values if you want to try it out for yourselves.
Using the Macro
To use the macro, select your token from the dropdown, and add the username or organization name for the repository you want to pull information from.
Pull requests and issues have a query field. You can use Github's Query language to select pull requests or issues you want to display.