Github Actions to publish markdown

[codemedic]

Hi, do you have any plans or are you aware of any github actions bases on this library, to publish markdown documents to Confluence?

[jamsinclair]

Hey @codemedic, I don't have any plans to release one myself. Doing a quick search around I don't see any actions based on this library, there are some markdown uploaders to confluence though (markdown-confluence).

Rolling your own should be pretty straightforward:

Action

name: Publish to Confluence

on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
  workflow_dispatch:

jobs:
  publish-docs:
    runs-on: ubuntu-latest
    
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '22'

      - name: Install dependencies
        run: npm install marklassian

      - name: Publish to Confluence
        env:
          CONFLUENCE_BASE_URL: ${{ secrets.CONFLUENCE_BASE_URL }}
          CONFLUENCE_PARENT_ID: ${{ secrets.CONFLUENCE_PARENT_ID }}
          ATLASSIAN_USERNAME: ${{ secrets.ATLASSIAN_USERNAME }}
          ATLASSIAN_API_TOKEN: ${{ secrets.ATLASSIAN_API_TOKEN }}
          CONFLUENCE_SPACE_KEY: ${{ secrets.CONFLUENCE_SPACE_KEY }}
        run: node scripts/upload-to-confluence.js

Script

import { markdownToAdf } from 'marklassian';
import fs from 'fs';
import path from 'path';

// Configuration
const config = {
  confluenceBaseUrl: process.env.CONFLUENCE_BASE_URL || 'https://your-domain.atlassian.net/wiki',
  confluenceParentId: process.env.CONFLUENCE_PARENT_ID || '123456789',
  atlassianUserName: process.env.ATLASSIAN_USERNAME || 'your-email@example.com',
  atlassianApiToken: process.env.ATLASSIAN_API_TOKEN || 'your-api-token',
  confluenceSpaceKey: process.env.CONFLUENCE_SPACE_KEY || 'YOUR_SPACE_KEY',
  folderToPublish: process.env.FOLDER_TO_PUBLISH || './docs',
  contentRoot: '/wiki/rest/api/content'
};

// Create authorization header
const auth = Buffer.from(
  `${config.atlassianUserName}:${config.atlassianApiToken}`
).toString('base64');

const headers = {
  'Authorization': `Basic ${auth}`,
  'Content-Type': 'application/json',
  'Accept': 'application/json'
};

// Upload a single page to Confluence
async function uploadPage(title, adfContent) {
  const url = `${config.confluenceBaseUrl}${config.contentRoot}`;
  
  const body = {
    type: 'page',
    title: title,
    space: { key: 'YOUR_SPACE_KEY' }, // Update with your space key
    ancestors: [{ id: config.confluenceParentId }],
    body: {
      atlas_doc_format: {
        value: JSON.stringify(adfContent),
        representation: 'atlas_doc_format'
      }
    }
  };

  try {
    const response = await fetch(url, {
      method: 'POST',
      headers: headers,
      body: JSON.stringify(body)
    });

    if (!response.ok) {
      const error = await response.text();
      throw new Error(`Failed to upload: ${response.status} - ${error}`);
    }

    const data = await response.json();
    console.log(`✓ Uploaded: ${title} (ID: ${data.id})`);
    return data;
  } catch (error) {
    console.error(`✗ Error uploading ${title}:`, error.message);
    throw error;
  }
}

// Process markdown files in folder
async function publishDocuments() {
  const files = fs.readdirSync(config.folderToPublish)
    .filter(file => file.endsWith('.md'));

  console.log(`Found ${files.length} markdown file(s)\n`);

  for (const file of files) {
    const filePath = path.join(config.folderToPublish, file);
    const markdown = fs.readFileSync(filePath, 'utf-8');
    
    // Convert markdown to ADF
    const adf = markdownToAdf(markdown);
    
    // Use filename (without .md) as page title
    const title = path.basename(file, '.md');
    
    await uploadPage(title, adf);
  }

  console.log('\nAll documents published!');
}

// Run
publishDocuments().catch(console.error);

---

For an extra bonus you could probably add frontmatter to documents and parse it to add relevant metadata for the content upload api.

Hope it helps!!