Skip to main content
Skip table of contents

Include issues list ☁️

You can include information on issues from a GitHub repository by adding lists of issues in your Confluence page. For each issue you will get the title, status, assignee, created and last updated information.


Add the macro

You can add the macro either by:

  • typing directly /Github Issues and ENTER to add and edit the macro, or

  • using the Insert button from the editor toolbar and then picking the Github Issues macro from the “External Content” category of the macro library.

You will then be prompted to specify the following:

Project path

path to the repository

Can be either the relative path (e.g. owner/repo) or the absolute path (e.g https://github.com/owner/repo)

Search query (optional)

Query used to filter and sort the list of issues. Check out the section below for more information on querying.


Query specific sets of issues

As mentioned above you can add a query option to the macro to display a specifically filtered and sorted list of issues.

The filtering syntax supported by the Github API is available in their documentation here: https://docs.github.com/en/rest/pulls/pulls#list-pull-requests

Examples:

List all closed issues

state:closed

List all open issues and sort them in descending order by their creation date.

state:open&sort=created&order=desc

 

When adding search queries you can run the query and preview results simply by clicking out of the search query input field.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.