Include GitHub - Cloud ☁️

Owned by Sue Rocha
Last updated: Mar 27, 2023
3 min read

Updated documentation links

Please reference our new and improved documentation spaces: 

Include GitHub for Confluence 

You can include content from private GitHub projects / repos too. Once private links are added, the OAuth process will follow.

Include GitHub for Confluence Cloud provides a File, Pull Requests & Issues Macro

To add the GitHub Cloud macros for Confluence Cloud to a page:

  1. In the Confluence editor, choose Insert > Other Macros.

  2. Find and select the required macro ("External Content" category).

Speeding up macro input with auto-complete: Type /GitHub  or /Include to see a list of suggested macros.

To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the GitHub Cloud macro.

1. Macro "GitHub File": Include GitHub Cloud file by url

This macro allows the user to include a file from a GitHub repository in order to have an up-to-date version of it in a Confluence page.

Type /GitHub File and ENTER to specify the details of this macro like the url of the file, syntax highlighting, title and line numbers.

Note: Copy the file URL from your browser and paste it into the URL field.

Alternatively, you can also paste a GitHub file URL directly into the Confluence page editor.

You can also export your files to PDF or Word

2. Macro "GitHub Pull Requests": Include GitHub Cloud pull requests with the repo path

This macro allows the user to include pull requests from a GitHub repository. Type /GitHub Pull Requests and ENTER to specify the details of this macro like the repo path (e.g.owner/repo or https://github.com/owner/repo).

 

A query can be added to specify the macro. Ensure you tab out of the search query to ensure that the data refreshes.

See filtering syntax here: REST API endpoints for pull requests - GitHub Docs .

Examples:

  • base=target-branch-name&state=closed

  • state=closed&sort=created&direction=desc

Note: It is useful to copy/paste the repo path from the repo url

3. Macro "GitHub Issues": Include GitHub Cloud issues with the repo path

This macro allows the user to include issues from a GitHub repository. Type /GitHub Issues and ENTER to specify the details of this macro like the repo path (e.g.owner/repo or https://github.com/owner/repo).

 

A query can be added to specify the macro. Ensure you tab out of the search query to ensure that the data refreshes.

See filtering syntax here: REST API endpoints for search - GitHub Docs .

Examples:

  • state:closed

  • state:open&sort=created&order=desc

Note: It is useful to copy/paste the repo path from the repo url

On this page: