#27 - Add initial MKDocs directory structure and configuration files. #1
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build and publish documentation to GitHub Pages | ||
on: | ||
push: | ||
branches: | ||
- feature/* | ||
- master | ||
# tags: | ||
# - 'v[0-9]+.[0-9]+.[0-9]+' | ||
jobs: | ||
build: | ||
runs-on: ubuntu-22.04 | ||
# container: | ||
# image: python:3.9 | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- name: Install Python dependencies | ||
run: pip install -r docs/requirements.txt | ||
- name: Build, validate documentation using MkDocs | ||
run: | | ||
# git config --global --add safe.directory /__w/rmk/rmk | ||
mkdocs build --verbose --clean --strict | ||
rm -r site/ | ||
- name: Configure Git | ||
# if: startsWith(github.ref, 'refs/tags/') | ||
id: git-configuration | ||
run: | | ||
echo "Configure Git user.name and user.email." | ||
git config user.name github-actions | ||
git config user.email github-actions@github.com | ||
echo tag=${GITHUB_REF#refs/tags/} >> "${GITHUB_OUTPUT}" | ||
- name: Build, publish, version documentation using Mike | ||
# if: startsWith(github.ref, 'refs/tags/') | ||
run: | | ||
# mike deploy --update-aliases --push --rebase ${{ steps.git-configuration.outputs.tag }} latest |