Build Docs and Publish to gh-pages #14
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 Docs and Publish to gh-pages | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- "docs/**" | |
- "mkdocs.yml" | |
- "CHANGELOG.md" | |
- "**/README.md" | |
- ".github/workflows/docs.yml" | |
workflow_dispatch: | |
permissions: | |
contents: write | |
jobs: | |
publish_docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.12" | |
- name: Git client setup | |
run: | | |
git config user.name github-actions[bot] | |
git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
- name: Set version | |
run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV | |
- name: Test | |
run: | | |
echo $RELEASE_VERSION | |
echo ${{ env.RELEASE_VERSION }} | |
# - name: Build docs | |
# run: make docs-build VERSION=$RELEASE_VERSION | |
# - name: Deploy Docs | |
# run: make docs-deploy VERSION=$RELEASE_VERSION | |