publish-ghpages

Publish documentation on GitHub Pages.

Retrieve a project’s publication-ready documentation from GitHub Actions artifact storage, and then upload it to project’s gh-pages branch. The calling GitHub Actions workflow job MUST have permission to create or update file contents (contents: write).

Inputs

artifact-path:

(required; default value: "build/docs")

Publish the contents of this directory using GitHub Pages.

---

gh-token:

(required; default value: ${{ github.token }})

Provide or override the API token used by the GitHub Actions workflow.

---

cname:

Set a custom domain for the GitHub Pages site.

---

skip-artifact-downloads:

Set this to true when managing the contents of the runner’s working directory outside of this action.