February 27, 2024

Enhancing CI/CD Documentation with GitLab and Confluence Integration

Dilara Erecek

Product Marketer

Share this article

GitLab's CI/CD capabilities are essential for efficient development workflows. However, integrating GitLab CI/CD documentation into Confluence has been challenging. Git for Confluence changes this, allowing you to bring dynamic content from GitLab directly into your Confluence pages with ease.

And after reading this, if you're still pondering whether Git for Confluence is the right fit for your needs, we wanted to let you know that industry giants such as T-Mobile, Microsoft, Sony, and Booking.com have already chosen us.

Addressing GitLab-Specific Challenges:

  • Automatic Documentation Syncing: With GitLab for Confluence, your Confluence documentation automatically updates with every commit, merge request, and branch created in GitLab. This guarantees that your documentation is continuously up-to-date, mirroring the most recent developments in your projects.
  • Enhancing Project Collaboration: Whether you're contributing to open-source projects or overseeing private repositories, GitLab for Confluence integrates your GitLab content into Confluence seamlessly and securely.

Integration Journey: Linking GitLab with Confluence no longer requires complex steps or constant updates. By pasting your GitLab URL into the Git for Confluence macro, you activate an automatic bridge between your development activities and your documentation, ensuring a current single source of truth.

Step-by-Step Guide:

For an interactive learning experience, watch our detailed video guide on integrating GitHub with Confluence using Git for Confluence. This video walks you through each step, providing visual cues and additional tips to maximize the integration's benefits.

Deciding on Authorization Methods for GitLab with Git for Confluence

Git for Confluence streamlines accessing and displaying private GitLab resources within Confluence, offering two authorization methods tailored to different needs: Individual Access (OAuth 2.0) and Managed Access (Token).

  • Individual Access (OAuth 2.0): Users log in with their GitLab accounts via OAuth 2.0 to share private GitLab repositories on Confluence pages. This approach is user-centric, facilitating easy access and sharing.
  • Managed Access (Token): A more centralized method where admins set up a global access token for Confluence to fetch content from GitLab repositories. It ensures controlled access and stable sharing, with shared GitLab content remaining accessible in Confluence as long as the token has access, unaffected by individual user account changes. Admins also manage which Confluence user groups can share private GitLab resources, aligning with internal security policies.

Conclusion

By integrating GitLab with Confluence through Git for Confluence, teams achieve a harmonious workflow that enhances visibility, collaboration, and efficiency across software development projects.

FAQs

  • How to link GitLab to Confluence? Linking GitLab to Confluence is straightforward with Git for Confluence. Simply paste the GitLab URL into a Confluence macro to directly embed and automatically update GitLab content in your Confluence pages.
  • Can GitLab replace Confluence? While GitLab offers its own wiki for project documentation, Confluence is a more comprehensive solution for team collaboration and documentation. GitLab and Confluence serve different purposes and can be used complementarily for optimal project management and documentation.
  • How do I embed GitLab code in Confluence? To embed GitLab code in Confluence, copy the code's URL from GitLab and paste it into the Git for Confluence macro. This will automatically display the code within your Confluence documentation.
  • What is the difference between GitLab wiki and Confluence? The GitLab wiki is specifically designed for project documentation directly tied to GitLab repositories, whereas Confluence offers a broader range of features for team collaboration, project management, and documentation across various projects and tools.

Further Reading:

  • For insights on enhancing your Confluence pages with Markdown, see our guide on Confluence Markdown.
  • Learn how Confluence Code Block can be utilized in DevOps documentation for a more integrated documentation workflow.

Start your free trial! Do you want to learn more about Git for Confluence? Start your 30-day free trial to explore every feature of Git for Confluence and determine if it fits your needs.

Share this article