update_pages Sub-Action

This GitHub action is invoked by the main NISTtheDocs2Death Action to move built documentation into your designated pages-branch.

Usage

This action is invoked as a step of the composite workflow of the NISTtheDocs2Death Action. There is no reason to invoke this action yourself.

- name: Commit documentation changes
  uses: ./../../_actions/current/update_pages
  with:
    docs-folder: 'docs/'
    default-branch: 'main'
    pages-branch: 'nist-pages'
    pages-url: 'https://pages.nist.gov'

Note

This action must be synchronized with the invoked version of the NISTtheDocs2Death Action, but “usnistgov/NISTtheDocs2Death/borg_the_docs@${{ github.action_ref }}” doesn’t work, hence the clumsy uses: statement.

Inputs

docs-folder

The folder containing your Sphinx configuration.

default-branch

The default branch, as configured on GitHub.

pages-branch

The branch linked to your documentation server.

pages-url

URL of the web server for served documentation.

Implementation

This action implements a Docker workflow step. The Docker ENTRYPOINT wraps the Sphinx configuration directory in a SphinxDocs object, wraps the GITHUB_REPOSITORY in a Repository object, and invokes update_pages().

API

update_pages_action