test_local_deployment
Validate documentation builds and test local server configurations for repositories using static site generators like Jekyll, Hugo, or Docusaurus before deploying to GitHub Pages.
Instructions
Test documentation build and local server before deploying to GitHub Pages
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | Port for local server | |
| repositoryPath | Yes | Path to the repository | |
| skipBuild | No | Skip build step and only start server | |
| ssg | Yes | ||
| timeout | No | Timeout in seconds for build process |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"port": {
"default": 3000,
"description": "Port for local server",
"type": "number"
},
"repositoryPath": {
"description": "Path to the repository",
"type": "string"
},
"skipBuild": {
"default": false,
"description": "Skip build step and only start server",
"type": "boolean"
},
"ssg": {
"enum": [
"jekyll",
"hugo",
"docusaurus",
"mkdocs",
"eleventy"
],
"type": "string"
},
"timeout": {
"default": 60,
"description": "Timeout in seconds for build process",
"type": "number"
}
},
"required": [
"repositoryPath",
"ssg"
],
"type": "object"
}