Skip to content

Documentation Build and Deploy #614

Documentation Build and Deploy

Documentation Build and Deploy #614

#
# Copyright [2021-present] [ahoo wang <[email protected]> (https://github.com/Ahoo-Wang)].
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
name: Documentation Build and Deploy
on:
schedule:
- cron: '0 0 * * *'
push:
branches:
- main
paths:
- 'documentation/**'
pull_request:
branches:
- main
paths:
- 'documentation/**'
workflow_dispatch:
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@master
- name: Set up JDK 17
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'temurin'
server-id: github
settings-path: ${{ github.workspace }}
- name: Generate KotlinDoc
run: ./gradlew dokkaHtmlMultiModule
- name: Copy To Documentation
run: cp -R build/dokka/htmlMultiModule documentation/docs/public/dokka
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 18
cache-dependency-path: documentation/yarn.lock
cache: yarn
- name: Build VitePress site
working-directory: documentation
run: yarn add -D vitepress && yarn run docs:build
- name: Deploy to gh-pages
uses: crazy-max/ghaction-github-pages@v4
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
target_branch: gh-pages
build_dir: documentation/docs/.vitepress/dist/
fqdn: wow.ahoo.me
# - name: Build VitePress site with SITE_BASE
# working-directory: documentation
# env:
# SITE_BASE: /wow/
# run: yarn add -D vitepress && yarn run docs:build
#
# - name: Deploy to gh-pages-with-site-base
# uses: crazy-max/ghaction-github-pages@v4
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# with:
# target_branch: gh-pages-with-site-base
# build_dir: documentation/docs/.vitepress/dist/
#
# - name: Sync to Gitee
# uses: wearerequired/git-mirror-action@master
# env:
# SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
# with:
# source-repo: "[email protected]:Ahoo-Wang/Wow.git"
# destination-repo: "[email protected]:AhooWang/Wow.git"