Shared library to publish html and other resources to a GitHub pages branch off the main repository (typically
This shared library is typically used in conjunction with
mkdocs and after
mkdocs generates all the HTML, etc and the
calling pipeline stashes the contents into a specific
site-contents Jenkins stash.
The typical documentation build process goes like this:
- PR is merged into main in upstream repo
mkdocsis called to generate final documentation in upstream repo job.
site-contentsstash is generated in upstream repo job.
edgeXGHPagesPublish()is called to publish stash to GitHub pages.
|Name||Required||Type||Description and Default Value|
|repoUrl||true||str||Repo URL where GitHub pages are being published (typically in ssh format for Edgex).|
|credentialId||false||str||Jenkins credentialId used to authenticate to git to push contents.
|ghPagesBranch||false||str||Git branch where GitHub pages are stored.
|stashName||false||str||Stash name that contains generated site contents that will be published.