ci: update documentation workflow

This commit is contained in:
2025-03-26 04:12:49 -07:00
parent 5f1f9f7fff
commit 77d22521c0

View File

@@ -43,13 +43,55 @@ run-name: "📒 Docs Build"
# # # #
on: on:
# #
# Trigger Release
#
# update documentation every time a release is made
# #
release: release:
types: types:
- published - published
# #
# Trigger Push
#
# update documentation every time a file in docs/ folder is modified
# #
push: push:
paths: paths:
- docs/** - docs/**
# #
# Trigger Workflow Dispatch
#
# If any values are not provided, will use fallback env variable
# #
workflow_dispatch: workflow_dispatch:
inputs:
# #
# Image Name
#
# used in github image path
# ghcr.io/${{ env.IMAGE_GHCR_AUTHOR }}/${{ env.IMAGE_NAME }}
# #
WORKING_DIR:
description: '📁 Docs Folder'
required: true
default: './docs/site'
type: string
# #
# Trigger Cron
#
# update documentation every X hours
# #
schedule: schedule:
- cron: "0 */12 * * *" - cron: "0 */12 * * *"
@@ -58,11 +100,12 @@ on:
# # # #
env: env:
ASSIGN_USER: Aetherinox WORKING_DIR: ${{ github.event.inputs.WORKING_DIR || './docs/site' }}
BOT_NAME_1: EuropaServ ASSIGN_USER: Aetherinox
BOT_NAME_2: BinaryServ BOT_NAME_1: EuropaServ
BOT_NAME_DEPENDABOT: dependabot[bot] BOT_NAME_2: BinaryServ
BOT_NAME_RENOVATE: renovate[bot] BOT_NAME_DEPENDABOT: dependabot[bot]
BOT_NAME_RENOVATE: renovate[bot]
# # # #
# jobs # jobs
@@ -106,7 +149,8 @@ jobs:
# Documentation Setup Python # Documentation Setup Python
# # # #
- name: "🐍 Setup Python" - name: >-
🐍 Setup Python
id: task_docs_python_setup id: task_docs_python_setup
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:
@@ -141,12 +185,13 @@ jobs:
# Documentation Deploy # Documentation Deploy
# # # #
- name: "💽 Deploy" - name: >-
💽 Deploy
id: task_docs_deploy id: task_docs_deploy
uses: peaceiris/actions-gh-pages@v4 uses: peaceiris/actions-gh-pages@v4
with: with:
personal_token: ${{ secrets.ADMINSERV_TOKEN_CL }} personal_token: ${{ secrets.ADMINSERV_TOKEN_CL }}
publish_dir: ./docs/site publish_dir: "${{ env.WORKING_DIR }}"
# # # #