Update build_docs.yml #6
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build and Deploy Writerside Documentation | |
on: | |
push: | |
branches: ['main'] # Trigger the workflow when changes are pushed to the 'main' branch | |
workflow_dispatch: # Allow manual triggering of the workflow | |
permissions: | |
id-token: write | |
pages: write | |
env: | |
INSTANCE: Writerside/Kurocado Studio Styleguide # Adjust the instance based on your configuration | |
ARTIFACT: webHelpKSS2-all.zip # Adjust if needed | |
DOCKER_VERSION: 242.21870 | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
token: ${{ secrets.GITHUB_TOKEN }} | |
fetch-depth: 0 | |
- name: Build Writerside docs using Docker | |
uses: JetBrains/writerside-github-action@v4 | |
with: | |
instance: ${{ env.INSTANCE }} | |
artifact: ${{ env.ARTIFACT }} | |
docker-version: ${{ env.DOCKER_VERSION }} | |
path: Writerside # Specify the directory for Writerside docs | |
- name: Upload artifact | |
uses: actions/upload-artifact@v4 | |
with: | |
name: docs | |
path: | | |
artifacts/${{ env.ARTIFACT }} | |
retention-days: 7 | |
deploy: | |
environment: | |
name: github-pages | |
needs: build | |
runs-on: ubuntu-latest | |
steps: | |
- name: Download artifact | |
uses: actions/download-artifact@v4 | |
with: | |
name: docs | |
- name: Unzip artifact | |
run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir | |
- name: Setup Pages | |
uses: actions/[email protected] | |
- name: Upload artifact | |
uses: actions/[email protected] | |
with: | |
path: dir | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/[email protected] | |
- name: Print GitHub Pages URL | |
run: echo "Your site is deployed at ${{ steps.deployment.outputs.page_url }}" |