Bring information from GitHub into Confluence

Read on how to integrate GitHub with Confluence to increase team velocity and transparency
August 14, 2020
Productivity
Use-Case

I’ve got a couple of questions for you.

Do you write technical documentation? What about technical documentation that references code and files from GitHub?

In this article you will learn how to increase value of Confluence and GitHub working together.

Technical Specification

There is a good practice to lightly document your technical steps before jumping directly into the code. This practice helps you to structure thoughts and enables you to get some feedback on your implementation steps. One of the easiest ways to reference to the previous work is to link to the previously merged pull requests or concrete files.

In your tech spec you can add a link to a readme file from the repository you can use as an example. It may look something like this.

github-links-for-confluence-01.png

Then the person who reviews your technical specification can expand and review it without leaving Confluence and loosing the context.

github-links-for-confluence-02.png

Also you may want to reference a pull request on which your task depends or learns from.

github-links-for-confluence-03.png

Display GitHub open issues or pull requests

Another way to quickly grasp the amount of open pull request in GitHub is to use a link to the pull requests https://gthub.com/atlassian/quickstart-atlassian-jira/pulls in your product.

github-links-for-confluence-04.png

When you want to display the the latest open issues you could paste the link to the issues page from GitHub.

github-links-for-confluence-05.png

Release pages and milestones

Multiple organization create a future or the next release page where they prepare the main themes of the release as well as teams and participants of it. If you organization uses GitHub milestones GitHub links for Confluence will be helpful here as well. Just copy the link to the milestone from GitHub, for instance, https://github.ca/microsoft/vscode/milestone/126 , and insert it in Confluence using GitHub for Confluence macros.

github-links-for-confluence-06.png

If the milestone is not your thing, you could use list of open pull requests.

You can give GitHub links for Confluence a try TODAY.

If there is something missing please reach out.

Welcome to our world and let’s Move Work Forward together!

Products we’re proud of

Articles you might like

How to simplify project portfolio management using Jira
August 14, 2020
How to simplify project portfolio management using Jira
Jira is an incredibly powerful tool, however it may appear complex if not set up correctly. That’s why we’ve taken the time to help you set up what is called Project Central.
Read more >

New blog posts

How to integrate Bitbucket Server with Jenkins Pipelines
September 18, 2020
How to integrate Bitbucket Server with Jenkins Pipelines
We want to automate project build using a Parametrised Jenkins Pipeline of the source code stored in Bitbucket Server.
Read more >
Bring information from GitHub into Confluence
August 14, 2020
Bring information from GitHub into Confluence
Read on how to integrate GitHub with Confluence to increase team velocity and transparency
Read more >
How to simplify project portfolio management using Jira
August 14, 2020
How to simplify project portfolio management using Jira
Jira is an incredibly powerful tool, however it may appear complex if not set up correctly. That’s why we’ve taken the time to help you set up what is called Project Central.
Read more >