Generate and publish documentation #14
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: Generate and publish documentation | |
on: | |
release: | |
types: [published] | |
workflow_dispatch: | |
jobs: | |
publish_documentation: | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
environment: | |
name: pypi | |
url: https://pypi.org/p/fakeredis | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.12" | |
- name: Configure Git Credentials | |
run: | | |
git config user.name github-actions[bot] | |
git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
- name: Publish documentation | |
env: | |
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }} | |
run: | | |
pip install -r docs/requirements.txt | |
mkdocs gh-deploy --force | |
mkdocs --version |