feat: GitHub Pages deployment workflow and step support #169
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds comprehensive support for deploying documentation to GitHub Pages through both a standalone workflow and as a reusable pipeline step.
Changes
New Components:
GithubPagesWorkflow: A new component that creates a complete GitHub Actions workflow for building and deploying documentation to GitHub PagesGithubPagesDeployStep: A reusable pipeline step that can be integrated into CDK pipelines or other workflowsFeatures:
Configuration Options:
buildCommand: Required - command to generate documentationdocsFolder: Output directory (default: 'docs')customDomain: Optional custom domain for GitHub PagesworkflowName: Workflow file name (default: 'github-pages')branchName: Trigger branch (default: 'main')runnerTags: Runner configuration (default: ['ubuntu-latest'])nodeVersion: Node.js version (default: '20')runInstall: Enable/disable dependency installation (default: true)installCommand: Custom install commandartifactName: GitHub Pages artifact name (default: 'github-pages')Testing
Comprehensive test coverage includes:
Example Usage