Include from GitHub to Confluence Cloud
Include from GitHub to Confluence Cloud
Breadcrumbs

Changelog

Version 2.x

Maintenance

  • Update to third party dependencies

  • Documentation link update

  • Authentication flow update to prep for a future Forge requirement

Announcement

  • Continued Progress on Atlassian Forge Migration

    • As part of our ongoing migration of Include from GitHub to Confluence to the Atlassian Forge framework, we have now replaced the Get Started page with a new Forge-based module.

    • This update is another step forward in aligning with Atlassian's cloud app development standards. While this change modernizes our app architecture behind the scenes, it does not impact the user experience or functionality at this stage.

    • We’ll continue to roll out updates incrementally to ensure a smooth and transparent transition. For more information on the migration plan and future updates, please refer to our full communication here.

Announcement

  • Preparing for Atlassian Forge Migration

    • As part of our efforts to transition Include from GitHub to Confluence to the Atlassian Forge framework, our first release focuses on converting to the Forge manifest file. This is a foundational step in the migration process and will not introduce any changes to the app’s functionality or user experience.

    • For a detailed overview of our migration plan, including key timelines and what to expect, please refer to our full communication here.

Maintenance

  • Update to third party dependencies

Version 1.x

New Features

  • Added support for !include directives in PlantUML diagrams embedded in AsciiDoc and Markdown files.

    • Users can now include external PlantUML files using the !include directive for PlantUML embedded in Markdown and AsciiDoc files. This will enable better modularization and reuse of diagram components across files in the same repository.

Bug Fixes

  • Fixed an issue with relative images in AsciiDoc files not displaying and resulting in an error.

New Features

  • Added support for !include directives in PlantUML diagrams.

    • Users can now include external PlantUML files using the !include directive, enabling better modularization and reuse of diagram components across files in the same repository.

Improvements

  • Enhanced navigation for Table of Contents links in Markdown and AsciiDoc files.

    • Previously, clicking a Table of Contents link would take the user to the source file in Git. Now, the links navigate directly to the corresponding section within the file in Confluence.

  • PlantUML diagrams are now visible when exporting Confluence pages to PDF using the Confluence PDF Exporter.

Maintenance

  • Update to third party dependencies

Maintenance

  • Upgraded to the latest Plant UML version

Maintenance

New Features & Improvements

  • Supporting PlantUML in Markdown files 🥳

  • Improved “Getting Started” Pages 😀

  • Ensure code block are syntax highlighted even when missing a language in the AsciiDoc file

Bug Fixes

  • Fix PDF Export duplicated images due to limitation with Confluence caching mechanism

  • Show error when migration Bitbucket workspace is not found

  • Fix issue with Markdown rendering failure with “illegal group reference“

Maintenance

  • Third party dependency updates

Improvements

  • Support rendering of Markdown block elements

  • Improve how AsciiDoc code blocks are displayed in Scroll Viewport

Maintenance

  • Third party dependency updates

Bug Fixes

  • Display block img tags in Markdown

  • Display message regarding AsciiDoc syntax errors

Improvements

  • Upgrade to HTTP2

    • We are upgrading the app to use HTTP2. The installation of your app will be migrated usually within 48 hours to the new HTTP2 enabled domain.
      25-01-10

Maintenance

  • Third party dependency updates

Improvements

  • Added additional languages for syntax highlight support

    • Q

    • reStructured

    • Groovy

    • Protobuf

  • Support PDF Export for meta-data macros like pull requests, etc

Bug fix

  • Ensured AsciiDoc styles are applied for AsciiDoc files.

Maintenance

  • Third party dependency updates

Improvements

  • Lifting limitation on OAuth process when in Incognito mode

    • We lift the limitation we previously had off the back of a security fix that affected the OAuth process when accessing content from private repositories, specifically under the following conditions:

      • Chrome
        Incognito Mode: Browsers in incognito mode often block third-party cookies, which interferes with the OAuth authentication process.

      • Safari
        Default Settings: Safari’s default setting, "Prevent Cross-Site Tracking," can prevent the necessary cookies from being shared across sites, disrupting the OAuth flow.

      • Firefox
        Default Standard Settings: that includes Enhanced Tracking Protection and Total Cookie Protection. These protections interfere with the OAuth process, as it often relies on third-party cookies to manage authentication across different domains.

    • Other Browser Security Settings: If your browser has additional third-party security restrictions enabled (e.g., blocking third-party cookies), these settings can also impact the OAuth process.

Users under these conditions should now be able to follow the OAuth process normally.
24-08-12

Security Fix

  • We've addressed a security vulnerability in the OAuth implementation.

    • Limitations:

      • The security fix introduces limitations that affect the OAuth process, specifically under the following conditions:

        • Chrome

          • Incognito Mode: Browsers in incognito mode often block third-party cookies, which interferes with the OAuth authentication process.

        • Safari

          • Default Settings: Safari’s default setting, "Prevent Cross-Site Tracking," can prevent the necessary cookies from being shared across sites, disrupting the OAuth flow.

        • Firefox

          • Default Standard Settings: that includes Enhanced Tracking Protection and Total Cookie Protection. These protections interfere with the OAuth process, as it often relies on third-party cookies to manage authentication across different domains.

        • Other Browser Security Settings: If your browser has additional third-party security restrictions enabled (e.g., blocking third-party cookies), these settings can also impact the OAuth process.

      • Refer to the FAQ for more details.

    • Action Required:

      • Re-authentication: All users will be required to re-authenticate with GitHub when using our app to render content from private GitHub repositories in Confluence.

      • Access Token Revocation: GitHub access tokens issued before this update have been revoked. Users are asked to configure the tokens again in the app configuration under the Confluence Admin settings.

    • Recommendations:

      • Review your account activity for any suspicious behavior and report it to our support team.

New Features

  • Confluence Cloud Dark theme support 🕶️

Improvement

  • Support inline HTML Image tags in Markdown

    • Example: Here is an inline image: <img src="image.jpeg" width="100" alt="Alt text"/>

Bug Fixes

  • GitHub Pull Request and Issue Breadcrumb working URLs

  • CSV Table UI rendering

  • Files with spaces rendered

  • Handle Markdown link path url spaces in Markdown

Improvements

  • Add branch meta data to File Macro UI

  • Improve code block rendering in Markdown files

Maintenance

  • Third party dependency updates

New Features

  • Support Rendering Mermaid files (.mmd & .mermaid)

    • Now supporting Mermaid file as well as Mermaid in Markdown.✨

Improvements

  • Improved database encryption

  • Improved UI for all macros

Maintenance

  • Update to third party dependencies

Security Updates

  • Third party library updates

Bug Fix

  • Collapsible option should defaulted to true for file and directory macro

Improvement

  • Show Title when rendering AsciiDoc files

Security

  • Third party library updates

New features

  • Support for GitHub Gists

    • Introducing a new macro that supports including GitHub Gists. Use the GitHub Gist macro to include Gists into your confluence pages.

Security

  • Library updates to address dependency vulnerabilities

Bug Fix

  • Bug fix affecting Admins in non-default groups not being able to access settings. In newer Confluence sites, the roles names include the site name. Bugfix uses a more appropriate API to check if the user is an Administrator.

New features

  • Collapsible File Option:

    • Including files and directories has gotten easier with the collapsible file option. The option can be activated in the File & Directory macro configuration menu which will allow you to collapse and expand the files included.Support for additional limited HTML within Markdown files has been added which will improve the rendering of HTML tables and certain HTML tags like <details> and <summary> .

  • Supporting limited HTML in Markdown:

    • We have improved the styling of tables with Markdown to help you distinguish table content at a glance.

  • Improved styling of Markdown tables

    • We have improved the styling of tables with Markdown to help you distinguish table content at a glance.

Bug Fixes

  • Support for rendering PlantUML files & blocks in AsciiDoc

  • Fix issue where images with spaces or special characters in their name couldn’t be included in Markdown

  • Slashes at the end of repos URL is handled correctly in the Pull Request macro

New features

  • Support for Shared Access Token Authentication

    • By default Include GitHub for Confluence uses personal OAuth to access private repositories. This ensures that each Confluence user can only access private repositories that they have access to, but requires a that each user has a GitHub account.

    • You can change the authentication to a shared access token for all Confluence user. This allows all users to see included files without any GitHub account. Check the documentation for more details.

New features

  • Mermaid Support

    • Mermaid in Markdown now supported & rendered. ✨ 

Privacy & Security

  • Enhanced privacy and security measures taken to delete any data stored when app is un-installed.

New features

  • PlantUML Support

    • Included PlantUML files are now supported and rendered. ✨

Improvements

  • Support Copy and Pasting Directory Paths

  • Support AsciiDoctor default CSS

  • Improve Markdown anchor links redirection

Maintenance & Security Updates

  • We released some updates related to normal maintenance and security.

Improvements

  • Adjust timeout so each included Asciidoc file has a 5 second fetch timeout to allow using Asciidoc files
    with many includes.

  • Increase file max limit of files from 20 to 50 rendered including for the Directory Macro

New features

  • Support for Including Directories: You can now include all files in a directory at once with the new GitHub Directory macro. Include your configuration files, REST API docs and other documentation directories from GitHub to share with your team.

    • If you add new files or delete existing ones in a directory, the changes will be automatically reflected in the Confluence page.

Improvements

Improvements

  • Improved configuration panel layout.

  • Updated the Getting Started links.

  • Updated to the latest Scribe OAuth library.

Improvements

  • Breadcrumbs in Macros

    • We improved the breadcrumbs for the pull request, tags, issues, commits and branches macros. It now also shows the filter applied and says what content is shown

Security

  • Disallowing using URLs which are not GitHub urls. This prevents including unexpected resources and having unexpected behavior if non-GitHub resources are included

New Features

  • Basic Support for CSV

    • CSV files are now rendered as a proper table.

Improvements

  • Improved Support for Various Languages

    • Added Syntax Highlighting for D, HCL, Objective-C, Swift

    • Improved Auto-Detection for Dockerfiles, HTML, Swift, Objective-C, HCL, Kotlin, D, Go

Maintenance & Improvements

  • Update in app links to new and improved documentation space

  • Add more file URL segment matchers in order to use copy and paste to render files

Bug Fix

  • Allow relative links in Markdown to work properly and take the user to the url

Announcement

  • We recently converted Include GitHub for Confluence to a paid app off the back of some new features and with this release we enforce the license. However, it is possible to still try it for free using the free trial option.

Security

  • Improved Security by upgrading to the latest version of some libraries

Announcements

  • We have converted Include GitHub for Confluence to a paid app off the back of some new features that we introduced recently like being able to convert files to PDF/Word.

New Features

  • Supporting PDF/Word Export for Files: You can now export your files using the GitHub File Macro to PDF or Word.

Security

  • Improved Security by upgrading to the latest version of some libraries

Bug Fixes

  • Add text to configuration to clarify that line number option is not available for Markdown & AsciiDoc files when using the File Macro

Security

  • Improved Security by upgrading to the latest version of some libraries

New Features

  • Introducing a hide header option in the file macro configuration form

Improvements

  • Autodetect XSL file formats and render as XML

  • Add contrasting gray background color to source code in markdown so it is easier to read

Bug Fixes

  • Allow plain links to be rendered in Markdown

Security

  • Improved Security by upgrading to the latest version of some libraries.

Security

  • Improved Security by upgrading to the latest version of some libraries.

Bug Fixes

  • Offer explicit logout in the Issue and Pull Request macro if user is logged in into multiple GitHub accounts

New Features

  • Include GitHub Issues in Confluence

    • Select the ‘GitHub Issues’ macro in Confluence to include issues from a GitHub repository.

  • Include GitHub Pull Requests in Confluence

    • Select the ‘GitHub Pull Requests’ macro in Confluence to include pull requests from a GitHub repository.

Security

  • Updated dependencies for some libraries

Features

  • Include public and private GitHub files in Confluence

    • Select the ‘GitHub file’ macro in Confluence to include a file from GitHub. The file will be always up to date in Confluence.