models/meta~ Meta

Represents metadata maintained for each page

Constructor

new Meta(repo, path, sha, gitRef, gitSha, publisherVersion)

Constructor

Parameters:
NameTypeDefaultDescription
repostring

The GitHub repo url the page belongs to

pathstringnull

The path of the page relative to the repo root

shastringnull

The sha256 hash of the page's content

gitRefstringnull

The git ref from where this page was published from

gitShastringnull

The git commit from where this page was published from

publisherVersionstringnull

The version of the action that published the page

Members

githubUrl :string

Fully qualified GitHub url of this page

Type:
  • string

Methods

publisherVersionConflict() → {boolean}

Returns:

True if the major/minor version of the action published this page is different than the current version

Type: 
boolean

toConfluenceProperties() → {object}

Returns:

With all metadata transformed as Confluence properties

Type: 
object