Skip to content

Documentation Website #254

Documentation Website

Documentation Website #254

Workflow file for this run

name: Documentation Website
on:
push:
branches:
- develop
paths:
- 'docs/**'
- '.all-contributorsrc'
- 'resources/Blendfiles/House.blend'
- 'resources/Blendfiles/Blender-Starter.blend'
- 'resources/Blendfiles/Tiles.blend'
- 'resources/ColorPalettes/**'
- 'resources/Windscale/**'
workflow_dispatch:
workflow_call:
inputs:
ref:
default: ''
required: true
description: The ref to checkout.
type: string
schedule:
- cron: '5 17 * * 1' # deploy the documentation website every monday after the new video went live
env:
HUGO_YOUTUBE_API_KEY: ${{ secrets.HUGO_YOUTUBE_API_KEY }}
jobs:
convert-color-palette-summer:
uses: ./.github/workflows/psd-to-png.yml
with:
ref: ${{ inputs.ref }}
input-file: ./resources/ColorPalettes/ColorPalette_Summer.psd
output-filename: ColorPalette_Summer.png
convert-windscale:
uses: ./.github/workflows/psd-to-png.yml
with:
ref: ${{ inputs.ref }}
input-file: ./resources/Windscale/Windscale.psd
output-filename: Windscale.png
convert-color-palette-summer-description:
uses: ./.github/workflows/psd-to-png.yml
with:
ref: ${{ inputs.ref }}
input-file: ./resources/ColorPalettes/ColorPalette_Summer_Description.psd
output-filename: ColorPalette_Summer_Description.png
create-blender-starter-kit:
runs-on: ubuntu-latest
needs: [convert-color-palette-summer, convert-windscale]
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.ref }}
- run: mkdir BlenderStarterKit
- run: cp ./resources/Blendfiles/House.blend ./BlenderStarterKit
- run: cp ./resources/Blendfiles/Tiles.blend ./BlenderStarterKit
- run: cp ./resources/Blendfiles/Blender-Starter.blend ./BlenderStarterKit
- run: mkdir ./BlenderStarterKit/scripts
- run: cp ./docs/content/docs/docs-visual/blender/assets/BoundfoxStudios-Export.py ./BlenderStarterKit/scripts
- uses: actions/download-artifact@v4
with:
name: ColorPalette_Summer.png
path: ./BlenderStarterKit/textures/
- uses: actions/download-artifact@v4
with:
name: Windscale.png
path: ./BlenderStarterKit/textures
- run: zip -r ./BlenderStarterKit/BlenderStarterKit.zip ./BlenderStarterKit/*
- uses: actions/upload-artifact@v4
with:
name: BlenderStarterKit
path: ./BlenderStarterKit/BlenderStarterKit.zip
create-blender-studio:
runs-on: ubuntu-latest
needs: [convert-color-palette-summer]
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.ref }}
- run: mkdir BlenderStudio
- run: cp ./resources/Blendfiles/Blender-Studio.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Bush.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Container.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Fence.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Flower.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Grass.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/House.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/LogPile.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Mushroom.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Reed.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Sunflower.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Tent.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Tiles.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Towers.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Transitions.blend ./BlenderStudio
- run: cp ./resources/Blendfiles/Tree.blend ./BlenderStudio
- run: mkdir ./BlenderStudio/scripts
- run: cp ./docs/content/docs/docs-visual/blender/assets/BoundfoxStudios-Export.py ./BlenderStudio/scripts
- uses: actions/download-artifact@v4
with:
name: ColorPalette_Summer.png
path: ./BlenderStudio/textures/
- run: zip -r ./BlenderStudio/BlenderStudio.zip ./BlenderStudio/*
- uses: actions/upload-artifact@v4
with:
name: BlenderStudio
path: ./BlenderStudio/BlenderStudio.zip
check-broken-links:
runs-on: ubuntu-latest
needs: [create-blender-starter-kit, create-blender-studio, convert-color-palette-summer, convert-color-palette-summer-description]
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.ref }}
- uses: ./.github/actions/download-all-artifacts
- uses: ./.github/actions/hugo-check-broken-links
deploy:
runs-on: ubuntu-latest
if: github.event_name != 'workflow_call'
needs: [check-broken-links, create-blender-starter-kit, create-blender-studio, convert-color-palette-summer, convert-color-palette-summer-description]
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: ./.github/actions/download-all-artifacts
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm ci
working-directory: docs
- run: npm run publish
working-directory: docs
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/public
user_name: "Boundfox Studios Publish Bot"
user_email: "info@boundfoxstudios.com"
commit_message: ":rocket: Deploy Docs"
cname: docs.fairytaledefender.de