Publish content to Confluence

This action publishes content to a Confluence site.

Confluence REST API

curl -u admin@example.com:api_token \
  -X POST \
  -H 'Content-Type: application/json' \
  -d'{"type":"page","title":"new page","space":{"key":"TST"},"body":{"storage":{"value":"<p>This is a new page</p>","representation":"storage"}}}' \
  https://your-domain.atlassian.net/wiki/rest/api/content/

Contributing

Set up

Install the dependencies

$ npm install

Run the tests ✔️

$ npm test

 PASS  ./index.test.js
  ✓ throws invalid number (3ms)
  ✓ wait 500 ms (504ms)
  ✓ test runs (95ms)

...

Package for distribution

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.

Run package

npm run package

Since the packaged index.js is run from the dist folder.

git add dist

Usage

You can now consume the action by referencing the v1 branch

uses: gabrieltaylor/publish-to-confluence@v1
env:
  CONFLUENCE_API_TOKEN: ${{ secrets.CONFLUENCE_API_TOKEN }}
with:
  type: 'page'
  title: 'Page created by Github Action'
  body: 'Content added by Github Action'
  space: 'ENG'
  hostname: 'example.atlassian.net'
  username: 'me@example.com'