README.md

action-confluence-sync

Action confluence sync that can be used to publish markdown documents to confluence. This action is a thin wrapper around the mark See the action.yaml file for details of required inputs.

Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

• gomplate
• Docker
• python
• taskfile

Usage

To use this action, make a file .github/workflows/confluence.yml. Here's a template to get started:

name: confluence-sync

on:
  pull_request:
  push:
    branches: [main]

jobs:
  confluence:
    runs-on: ubuntu-20.04
    steps:
      - name: Check out a copy of the repo
        if: ${{ !env.ACT }}
        uses: actions/checkout@v2
        with:
          fetch-depth: 0

      - name: Get changed files
        id: changed-files
        uses: tj-actions/[email protected]
        with:
          files: |
            *.md
          files_ignore: |
            *.tpl.md

      - name: Sync confluence
        uses: hadenlabs/[email protected]
        with:
          confluence_base_url: '${{ secrets.CONFLUENCE_BASE_URL }}'
          confluence_user: '${{ secrets.CONFLUENCE_USER }}'
          confluence_token: '${{ secrets.CONFLUENCE_ACCESS_TOKEN }}'
          files: '${{ steps.changed-files.outputs.all_changed_files }}'

Inputs

parameter	description	required	default
confluence_url	base url of confluence	true
confluence_username	confluence username	true
confluence_token	token of user	true
files	files to sync	true

Runs

This action is an composite action.

Help

Got a question?

File a GitHub issue.

Contributing

See Contributing.

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Using the given version number of MAJOR.MINOR.PATCH, we apply the following constructs:

1. Use the MAJOR version for incompatible changes.
2. Use the MINOR version when adding functionality in a backwards compatible manner.
3. Use the PATCH version when introducing backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

• In the context of initial development, backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
• In the context of pre-release, backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

Copyright

Copyright © 2018-2022 Hadenlabs

Trademarks

All other trademarks referenced herein are the property of their respective owners.

License

The code and styles are licensed under the LGPL-3.0 license See project license..

Don't forget to 🌟 Star 🌟 the repo if you like action-confluence-sync

Your feedback is appreciated