publish mkdocs to github pages #213
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: publish mkdocs to github pages | |
on: | |
workflow_dispatch: | |
push: | |
branches: | |
- unidata_20.3.2 | |
paths: | |
- 'docs/**' | |
- 'mkdocs.yml' | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Setup Python and mkdocs | |
uses: actions/setup-python@v2 | |
with: | |
python-version: '3.8' | |
- name: Update pip | |
run: | | |
# install pip=>20.1 to use "pip cache dir" | |
python3 -m pip install --upgrade pip | |
- name: Create mkdocs_requirements.txt | |
run: | | |
echo "markdown==3.3.7" >> mkdocs_requirements.txt | |
echo "mkdocs" >> mkdocs_requirements.txt | |
echo "mkdocs-unidata" >> mkdocs_requirements.txt | |
echo "fontawesome_markdown" >> mkdocs_requirements.txt | |
- name: Get pip cache dir | |
id: pip-cache | |
run: echo "::set-output name=dir::$(pip cache dir)" | |
- name: Cache dependencies | |
uses: actions/cache@v1 | |
with: | |
path: ${{ steps.pip-cache.outputs.dir }} | |
key: ${{ runner.os }}-pip-${{ hashFiles('**/mkdocs_requirements.txt') }} | |
restore-keys: | | |
${{ runner.os }}-pip- | |
- name: Install python dependencies | |
run: python3 -m pip install -r ./mkdocs_requirements.txt | |
- run: mkdocs build | |
- name: Deploy to gh-pages | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./site |