Bachelor 2022 - Anders Larsen & Theis Tengs

This action converts your markdown files into the specified Atlassian Confluence space.

First you need to create an API token for the user, you want to use for the action. We recommend that you create a new user, that is only used for this action, in order to get the full benefits from the action. See here for how to set up your API token.

The necessary environment variables are as follows:

CONFLUENCE_URL

The base URL for the Atlassian network. Follows the form: 'https://[your-network-name].atlassian.net'

CONFLUENCE_SPACE_KEY

The key of the space that is being uploaded to. Can be found in the URL for your space. More info here

AUTH_USERNAME

The email used for the user connected to the API token. We recommend setting this as a GitHub secret.

AUTH_API_TOKEN

The API token generated for the user. We recommend setting this as a GitHub secret.

Required The path from the root of your repository, to the folder containing the markdown documentation. Default ./.

Without github secrets:

- name: Conversion step
 env:
  CONFLUENCE_URL: 'https://network.atlassian.net/wiki'
  CONFLUENCE_SPACE_KEY: 'spaceKey'
  AUTH_USERNAME: 'your@email.com'
  AUTH_API_TOKEN: 'PeRsOnalApItOKen'
 uses: TTengs/MarkdownToConfluence@latest
 with:
  fileslocation: './documentation'

With GitHub secrets

- name: Conversion step
 env:
  CONFLUENCE_URL: 'https://network.atlassian.net/wiki'
  CONFLUENCE_SPACE_KEY: 'spaceKey'
  AUTH_USERNAME: ${{ secrets.AUTH_USERNAME }}
  AUTH_API_TOKEN: ${{ secrets.AUTH_API_TOKEN }}
 uses: TTengs/MarkdownToConfluence@latest
 with:
  fileslocation: './documentation'

The structure of the markdown files in the filesystem, dictates the structure of the pages on confluence.

All files should be located in a single folder, which is the one specified in fileslocation. This folder will not contain any markdown files (if so, they won't be recognized as pages), but only folders, a prefix- and settings-file. Every subfolder under this folder, will be considered a page, these are referenced later as a "folderpage".

A folderpage can contain other folderpages, as well as markdown files. The file containing the content of the folderpage, MUST be named "index.md". Any other markdown files inside the folderpage, will be considered as a child page.

A child page can also be defined by another folderpage inside a folderpage. This is only recommended, if you need child pages for that folderpage as well. Otherwise, we recommend simply using multiple markdown files.

The name of a folderpage dicates the name of the page in confluence.

Folderpages with multiple markdown files, will contain child pages named after the name of the markdown file.

Any folderpage can contain a prefix.txt file, dictating the prefix for all it's child pages.

The following filestructure:

Will look like this, once uploaded to Confluence:

This tool comes with a number of modules, which add extra markdown syntax, specialized for Confluence and other tools.

• Jira Tickets
• Attachments
• Mermaid.js
• Table of Contents