https://github.com/mbovo/mark2confluence

Github Action to render markdown to confluence pages
https://github.com/mbovo/mark2confluence

Last synced: 2 months ago
JSON representation

Github Action to render markdown to confluence pages

• Host: GitHub
• URL: https://github.com/mbovo/mark2confluence
• Owner: mbovo
• License: mit
• Created: 2021-05-26T11:33:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-01T15:05:18.000Z (about 3 years ago)
• Last Synced: 2024-10-09T11:58:25.202Z (3 months ago)
• Language: Shell
• Size: 22.5 KB
• Stars: 6
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mark2confluence

GitHub Action for converting markdown files into Confluence pages

This Action uses [mark](https://github.com/kovetskiy/mark) to accomplish this task

## Inputs

### Required

`action` - `[publish, dry-run, verify]`

- `verify`  - Verify only the conversion from markdown to html

- `dry-run` - Verify in dry-run the conversion will success (connecting to confluence)

- `publish` - Use the given confluence account and push the generated pages

## Required Environment variables

```yaml

BASE_URL: https://your.confluence.url # Confluence base url of your instance

DOC_DIR: docs # Docs directory based on the git repo root

CONFLUENCE_USERNAME: ${{ secrets.CONFLUENCE_USERNAME }} # CONFLUENCE_USERNAME (Confluence username) must be set in GitHub Repo secrets

CONFLUENCE_PASSWORD: ${{ secrets.CONFLUENCE_PASSWORD }} # CONFLUENCE_PASSWORD (Confluence api key) must be set in GitHub Repo secrets

```

## Example workflow

```yaml

name: Docs Test and Publish

on: pull_request

jobs:

  helm-suite:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v2

    # - name: myOtherJob1

    #   run:

    - name: Test Docs generation

      uses: draios/infra-ghaction-mark2confluence@main

      with:

        action: "test"

      env:

        BASE_URL: https://your.confluence.url

        CONFLUENCE_USERNAME: ${{ secrets.CONFLUENCE_USERNAME }}

        CONFLUENCE_PASSWORD: ${{ secrets.CONFLUENCE_PASSWORD }}

    - name: Publish Docs

      uses: draios/infra-ghaction-mark2confluence@main

      with:

        action: "publish"

      env:

        BASE_URL: https://your.confluence.url

        CONFLUENCE_USERNAME: ${{ secrets.CONFLUENCE_USERNAME }}

        CONFLUENCE_PASSWORD: ${{ secrets.CONFLUENCE_PASSWORD }}

```