mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
69 lines
3.8 KiB
YAML
69 lines
3.8 KiB
YAML
# ==================================================================================================================== #
|
|
# Authors: #
|
|
# Patrick Lehmann #
|
|
# Unai Martinez-Corral #
|
|
# #
|
|
# ==================================================================================================================== #
|
|
# Copyright 2020-2022 The pyTooling Authors #
|
|
# #
|
|
# 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. #
|
|
# #
|
|
# SPDX-License-Identifier: Apache-2.0 #
|
|
# ==================================================================================================================== #
|
|
name: Documentation
|
|
|
|
on:
|
|
workflow_call:
|
|
inputs:
|
|
artifact:
|
|
description: 'Name of the documentation artifact.'
|
|
required: false
|
|
default: ''
|
|
type: string
|
|
|
|
jobs:
|
|
BuildTheDocs:
|
|
name: 📓 Run BuildTheDocs
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: ⏬ Checkout repository
|
|
uses: actions/checkout@v3
|
|
|
|
- name: 🛳️ Build documentation
|
|
uses: buildthedocs/btd@v0
|
|
with:
|
|
skip-deploy: true
|
|
|
|
- name: 📤 Upload 'documentation' artifacts
|
|
if: inputs.artifact != ''
|
|
uses: actions/upload-artifact@v3
|
|
with:
|
|
name: ${{ inputs.artifact }}
|
|
path: doc/_build/html
|
|
retention-days: 1
|
|
|
|
- name: '📓 Publish site to GitHub Pages'
|
|
if: inputs.artifact == '' && github.event_name != 'pull_request'
|
|
run: |
|
|
cp --recursive -T doc/_build/html public
|
|
cd public
|
|
touch .nojekyll
|
|
git init
|
|
cp ../.git/config ./.git/config
|
|
git add .
|
|
git config --local user.email "BuildTheDocs@GitHubActions"
|
|
git config --local user.name "GitHub Actions"
|
|
git commit -a -m "update ${{ github.sha }}"
|
|
git push -u origin +HEAD:gh-pages
|