- Source
Methods
(async, inner) cleanup() → {Promise.<void>}
Cleanup all pages from confluence
- Source
Returns:
- Type:
- Promise.<void>
(inner) cleanupSummary(siteName)
Write action summary after cleanup
Parameters:
| Name | Type | Description |
|---|---|---|
siteName | string | The site name |
- Source
(inner) errorHandler(error)
Handles errors and fails the action
Parameters:
| Name | Type | Description |
|---|---|---|
error | Error | The Error that occurred |
- Source
(async, inner) findParentPage() → {number}
Find the id of the Confluence page Configured to be the parent for our documents
- Source
Throws:
Error if the configured parent page does not exist
Returns:
The id of the configured parent page
- Type:
- number
(async, inner) sync() → {Promise.<void>}
Sync local markdown documentation with Confluence
- Source
Returns:
- Type:
- Promise.<void>
(async, inner) syncHome(repo, siteName, localPage, renderer) → {Promise.<number>}
Create or update home page from README.md
Parameters:
| Name | Type | Description |
|---|---|---|
repo | string | |
siteName | string | |
localPage | LocalPage | |
renderer | AssetRenderer |
- Source
Returns:
Home page id
- Type:
- Promise.<number>
(async, inner) syncPages(home, localPages, renderer)
Sync Local pages with Confluence
Parameters:
| Name | Type | Description |
|---|---|---|
home | number | The id of the home page |
localPages | Array.<LocalPage> | Array of pages |
renderer | AssetRenderer |
|
- Source
(inner) syncSummary(siteName, url)
Write action summary
Parameters:
| Name | Type | Description |
|---|---|---|
siteName | string | The name of the documentation site |
url | string | The Confluence url of the published documentation |
- Source
(async, inner) union(parentPageId, localPages) → {Array.<(LocalPage|RemotePage)>}
Creates a union of remote and local pages that need to be synced with Confluence
Parameters:
| Name | Type | Description |
|---|---|---|
parentPageId | number | The parent page to all pages |
localPages | Array.<LocalPage> |
- Source
Returns:
An array of pages to be synced
- Type:
- Array.<(LocalPage|RemotePage)>
(async, inner) unpublish(remotePages)
Parameters:
| Name | Type | Description |
|---|---|---|
remotePages | Iterable.<RemotePage> |
- Source