Bring information from GitHub into Confluence

Integrate GitHub with Confluence to increase team velocity and transparency. Enrich information about pull requests, read me and other files, issues and repositories. Know the state of those items without leaving Confluence.
December 16, 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.

Confluence GitHub integration for readme files

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

Confluence GitHub integration for open readme files

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

Confluence GitHub integration for pull requests and user profiles

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.

Confluence GitHub integration for GitHub issues

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

Confluence GitHub integration shows a list of issues in Confluence

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.

Confluence GitHub integration for GitHub milestones

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
January 3, 2022
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 can I generate a quote for Atlassian Marketplace application
February 2, 2023
How can I generate a quote for Atlassian Marketplace application
Easy to follow process to create a quote for an Atlassian Marketplace application.
Read more >
The Top 5 Features of the Atlassian Jira and Github Integration
December 19, 2022
The Top 5 Features of the Atlassian Jira and Github Integration
Integrating Atlassian Jira and GitHub can be a game-changer for teams looking to streamline their workflow and improve collaboration. With the right integration, teams can track code changes and project progress in one place, improve communication and collaboration, and gain valuable insights into their work. In this post, we'll highlight the top 5 features of the Atlassian Jira and GitHub integration that make it stand out from the competition.
Read more >
Manage release notes with Atlassian Confluence and Microsoft Azure DevOps
December 8, 2022
Manage release notes with Atlassian Confluence and Microsoft Azure DevOps
Learn how to embed Azure DevOps content to create readable release notes in Atlassian Confluence.
Read more >