DevOps Help

Document

Prerequisites

Consuming the workflow

name: Writerside Documentation Pipeline permissions: contents: write id-token: write pages: write pull-requests: write jobs: document: uses: kurocado-studio/dev-ops/.github/workflows/workflow.document.yml@main secrets: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: instance_id: dcs

Overview

Builds and deploys project documentation using Docker-based builders.

GitHub RepositoryGitHub Actions RunnerDocumentation BuildersGitHub APIalt[Workflow Successful][Workflow Failed]Trigger Writerside Documentation WorkflowInstall DependenciesBuild Docs using Writerside Docker BuilderBuild Results (Artifact, report.json)Save Artifact with Build ResultsUnzip ArtifactConfigure GitHub PagesUpload Artifact to GitHub PagesDeploy to GitHub PagesReport Workflow SuccessUpdate Status as SuccessfulReport Workflow FailureUpdate Status with ErrorsGitHub RepositoryGitHub Actions RunnerDocumentation BuildersGitHub API
Last modified: 27 March 2025