GitHub links for Confluence Cloud permits you to view real time information from GitHub in Confluence.

Connect GitHub links for Confluence with your organization

Important: Make sure that when you authorize our GitHub OAuth App to access your data you select the organization you want to use the App with.

Here is short (25 seconds) demo video on where to make sure that GitHub links GitHub App is authorized to access your organization's data.

Please watch the video below and pay attention that the org access is given, not only personal.

Important: if you need to reconnect the GitHub links App with your organization, please 1 - disconnect the App in the Confluence (go to the Configuration page) and 2 - delete access for our App on the GitHub side (in org settings).

If you forgot to grant permissions to required organization or you don’t have permissions to allow it and you need to request the access from your org owner. You can do this by going to User profile → Settings → Integrations → Applications → Authorized OAuth Apps and make sure there is a green tick (V) in front of your organization. See the picture below.

Configuration

If you want to use this App only with public repositories - you do NOT need any configuration. You only need to follow the next steps if you need to connect to your private organization/repositories.

A. Navigate to the Settings → Github linker Configuration page

B. Click on the "Connect" button and authenticate yourself and authorize the App to see your private organization.

When you allow GitHub App to access your data, please make sure that you grant permissions to your organization as well, not only your personal repositories.

Use with private repositories

To use the private repositories you need to follow the steps in the Configuration section above and allow our GitHub App to access your private repositories. We do not close or access source code, we use GitHub APIs to get additional information from the links inserted in Confluence.

Use cases & macro specifics

All use cases use public links so that you can reproduce them straight away.

Pull request information

https://github.com/facebook/react/pull/17484

Readme embedding

https://github.com/cjbarber/ToolsOfTheTrade/blob/master/readme.md

You can also keep the file open by checking the “Do you want to see extended information about the link“ checkbox.

Issue information

https://github.com/facebook/react/issues/17785

The list of the latest pull requests

https://github.com/microsoft/team-explorer-everywhere/pulls

The list of the latest issues

https://github.com/facebook/react/issues

The list of the issues with specific filters

You can pass the parameters to the macro to apply additional filters. This is done using URL parameters macro parameter.

Here are some examples of parameter usage.

milestone=192&labels=api,debug
labels=api,debug
CODE

The supported parameters are described below.

milestone string

If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.

assignee string

Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.

creator string

The user that created the issue.

mentioned string

A user that's mentioned in the issue.

labels string

A list of comma separated label names. Example: bug,ui,@high

sorting

What to sort results by. Can be either created, updated, comments.

Default: created

Can be one of: created, updated, comments

directionstring

The direction to sort the results by.

Default: desc

Can be one of: asc, desc

sincestring

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

User and organization information

https://github.com/moveworkforward

https://github.com/facebook

https://github.com/Atlassian

https://github.com/spudbean

Milestone information

https://github.com/facebook/react/milestone/40

Release information

https://github.com/facebook/react/releases/tag/v16.12.0

The latest release information

https://github.com/facebook/react/releases/latest

The list of the latest releases

https://github.com/facebook/react/releases

The list of labeled issues of a milestone

Set the filters in the dialog of the macro. 

The parameters used are listed on GitHub in a table - https://developer.github.com/v3/issues/#list-issues-for-a-repository

Save the macros to see the changes.

Known issues

  • GitHub Enterprise is not supported at the moment. The reason is that our App gets called when a particular github.com link is inserted on the page, it is not possible to dynamically tell Confluence with URLs should be handled by our App.

  • Github links for Confluence can be used with private and public repositories and organizations.

  • We cannot get more fine-grained permissions at this stage, due to restrictions from GitHub API.

Security and compliance

We do not store or read any of your code or user data. We only use GitHub APIs to enrich the link you inserted.

Get help

You can create a Jira Service Desk support request with all information you could gather, please include the screenshot of the configuration, links and time stamps.

Updated: