list of files and folders (bash style) to copy into the root of the gh-pages branch these files will be copied to the root, not the DOCUMENT_PUBLISH_FOLDER

Documentation will be generated only when this branch is pushed

The name of the npm script to run, expecting the documentation to get generated. For example:

npm run ${DOCUMENT_GENERATE_HOOK}

After the documentation generation script is run, autodocs expects to find its output in this folder. The files located here will get published.

Documentation will be generated only on one of the jobs for each build, use this to specify which one.

Joins DOCUMENT_PUBLISH_FOLDER_ROOT with DOCUMENT_PUBLISH_SUBFOLDER to get a concrete path to publish the documentation.

All documentation will be published under this root directory

This can be used for non-version-specific documentation

The documentation will be published in this subdirectory of the root directory.

This can be used for version-specific documentation

The name of the npm script to run, expecting the documentation to get tested. For example:

npm run ${DOCUMENT_TEST_HOOK}

By default, this will publish an all page, whose purpose is simply to list and link to all published API versions

Assuming default values for other configurations, if the versions of the project are currently 0.1, 0.2, 0.3, and 1.0

• http://USER.github.io/REPO/api/all/
• This URL will be published with an index.html file that links to:
  • http://USER.github.io/REPO/api/0.1/
  • http://USER.github.io/REPO/api/0.2/
  • http://USER.github.io/REPO/api/0.3/
  • http://USER.github.io/REPO/api/1.0/

Set to false to disable this behaviour.

Whether to clean up afterward, by deleting the directory that was published

Whether there are any assets to copy. Set to true only if intending to use DOCUMENT_ASSETS.

By default, this will publish a latest page, whose purpose is simply to redirect to the most recently publish API version

Assuming default values for other configurations, if the version of the project is currently 1.2.3,

• http://USER.github.io/REPO/api/latest/
• This URL will be published with an index.html file that redirects to:
• http://USER.github.io/REPO/api/1.2/

Set to false to disable this behaviour.

If set to 'true' DOCUMENT_PUBLISH_FOLDER is ignored, and the document is published in the root folder instead.

If using this module to publish something like a blog, instead of versioned software documentation, you should set this flag to true.

By default, publish will occur when a branch is pushed.

When this flag is set to true, publish will occur when a tag is pushed instead.

Set to true to skip step where documentation is generated. i.e. Do not run

npm run generatedocs

This is useful for testing and debugging purposes. Leaving this on in a CI environment would defeat the purpose of autodocs

Set to true to skips the entirety of the CI publish run function. None of the publishing related step will occur, except for setting any required environment variables.

This is useful for testing and debugging purposes. Leaving this on in a CI environment would defeat the purpose of autodocs

Set to false to do all of the steps in publishing, except for the final step of pushing the changes to the git remote.

This is useful for testing and debugging purposes. Leaving this on in a CI environment would defeat the purpose of autodocs

Set to true to skip step where documentation is tested. i.e. Do not run tests

npm run testdocs

This is useful when the generate command executes its own tests

Any tokens contained in the build output will be stripped out before being printed. This is to ensure security, especially if your CI's build logs are publicly available

Email address to use when creating the Git commit

Name to use when creating the Git commit

The major version of the project.

1.2.3 --> 1

The minor version of the project

1.2.3 --> 2

The patch version of the project

1.2.3 --> 3

The directory that the project being published ios located in.