Description

A github action that builds site.yaml which can be used to deploy pages using bsorrentino/maven-confluence-plugin

Usage

Use the folowing code in the workflow:

- name: Generate site.yaml
  uses: simasbu/confluence-site-descriptor-action@main
  with:
    localDirectory: "confluence"
    parentPageTitle: "Home"
    homePageTitle: "Hello world"
    spaceKey: "SPACE"

The action.yml contains definitions of the inputs and output for the action.

Each directory must:

• have a README.md file
• not contain empty spaces in the name

Directory name will become a page name on confluence. Use underscores in places where you want to have spaces. E.g.:

Folder name	Resulted page name
My Product	Name not valid
My_Product	My Product

File structure

./
├── confluence/
| ├── README.md
| ├── My_Product/
│ | ├── README.md
| └── My_Team/
│ | ├── README.md

Code in Main

Install the dependencies

$ npm install

Build the typescript and package it for distribution

$ npm run build && npm run package

Build, format, lint, package and test

$ npm run build && npm run format && npm run lint && npm run package && npm test

Run the tests ✔️

$ npm test

 PASS  __tests__/main.test.ts
  ✓ success flow (81ms)
...