mirror of
https://github.com/obsproject/obs-studio.git
synced 2026-05-18 13:33:27 -04:00
afc13fb796
The v4 tag currently points to v4.6.2 which is
ea165f8d65.
https://github.com/actions/upload-artifact/releases/tag/v4.6.2
75 lines
3.0 KiB
YAML
75 lines
3.0 KiB
YAML
name: Generate Documentation
|
|
description: Updates Sphinx-based documentation
|
|
inputs:
|
|
sourceDirectory:
|
|
description: Path to repository checkout
|
|
required: false
|
|
default: ${{ github.workspace }}
|
|
disableLinkExtensions:
|
|
description: Disable Sphinx link extensions
|
|
required: false
|
|
default: 'false'
|
|
runs:
|
|
using: composite
|
|
steps:
|
|
- name: Update Version Number and Copyright ↗️
|
|
id: setup
|
|
shell: bash
|
|
run: |
|
|
: Update Version Number and Copyright ↗️
|
|
if [[ "${RUNNER_DEBUG}" ]]; then set -x; fi
|
|
|
|
: "${major:=}"
|
|
: "${minor:=}"
|
|
: "${patch:=}"
|
|
|
|
# This expression will first try to match all the LIBOBS_API_[...]_VER
|
|
# lines in 'obs-config.h', before removing the '#define ' prefix and
|
|
# trimming away whitespace characters and linebreaks.
|
|
# This will yield a single line with the each major, minor, and patch
|
|
# version variable name followed by its value, so every even item
|
|
# in this string will contain a version part.
|
|
|
|
read -r _ major _ minor _ patch _ <<< \
|
|
"$(grep -E -e "#define LIBOBS_API_(MAJOR|MINOR|PATCH)_VER *" libobs/obs-config.h \
|
|
| sed 's/#define //g' \
|
|
| tr -s ' ' \
|
|
| tr '\n' ' ')"
|
|
|
|
# This expression simply replaces the definition of the 'version' and
|
|
# 'release' variables in the Python script with updated variants using
|
|
# the version tokens set by the previous expression.
|
|
# The copyright variable assignment is updated to use the current
|
|
# local year as the second year value.
|
|
|
|
sed -i -E \
|
|
-e "s/version = '([0-9]+\.[0-9]+\.[0-9]+)'/version = '${major}.${minor}.${patch}'/g" \
|
|
-e "s/release = '([0-9]+\.[0-9]+\.[0-9]+)'/release = '${major}.${minor}.${patch}'/g" \
|
|
-e "s/copyright = '(2017-[0-9]+, Lain Bailey)'/copyright = '2017-$(date +"%Y"), Lain Bailey'/g" \
|
|
${{ inputs.sourceDirectory }}/docs/sphinx/conf.py
|
|
|
|
if [[ '${{ inputs.disableLinkExtensions }}' == 'true' ]]; then
|
|
sed -i -e "s/html_link_suffix = None/html_link_suffix = ''/g" \
|
|
${{ inputs.sourceDirectory }}/docs/sphinx/conf.py
|
|
echo "artifactName=OBS Studio Docs (No Extensions)" >> $GITHUB_OUTPUT
|
|
else
|
|
echo "artifactName=OBS Studio Docs" >> $GITHUB_OUTPUT
|
|
fi
|
|
|
|
echo "commitHash=${GITHUB_SHA:0:9}" >> $GITHUB_OUTPUT
|
|
|
|
- name: Install Sphinx 📜
|
|
uses: totaldebug/sphinx-publish-action@a44364271972de3b13c5b63801c2596dfde82413
|
|
with:
|
|
sphinx_src: ${{ inputs.sourceDirectory }}/docs/sphinx
|
|
build_only: true
|
|
target_branch: master
|
|
target_path: '../home/_build'
|
|
|
|
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
|
|
with:
|
|
name: ${{ steps.setup.outputs.artifactName }} ${{ steps.setup.outputs.commitHash }}
|
|
path: |
|
|
${{ runner.temp }}/_github_home/_build
|
|
!${{ runner.temp }}/_github_home/_build/.doctrees
|