fixed readme again #17
This file contains hidden or 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: Deploy MkDocs to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: | | |
| pip install uv | |
| uv venv | |
| uv pip install mkdocs mkdocs-material mkdocstrings[python] | |
| - name: Build MkDocs | |
| run: uv run mkdocs build --strict | |
| # Create a GH_PAT secret in your repository with a Personal Access Token | |
| - name: Configure Git for Deployment | |
| run: | | |
| git config --global user.name "github-actions[bot]" | |
| git config --global user.email "github-actions[bot]@users.noreply.github.com" | |
| git remote set-url origin https://x-access-token:${{ secrets.GH_PAT }}@github.com/dave-Lab-and-Engineering/python-build-utils.git | |
| # Deploy to GitHub Pages | |
| - name: Deploy to GitHub Pages | |
| run: echo uv run mkdocs gh-deploy --force --remote-branch gh-pages | |
| # | |
| #- name: Deploy to GitHub Pages | |
| # run: mkdocs gh-deploy --force --remote-branch gh-pages | |
| #- name: Deploy to GitHub Pages | |
| # run: uv run mkdocs gh-deploy --force | |
| # Note that GH_PAT is a secret that you need to create in your repository settings | |
| # - name: Deploy to GitHub Pages via github token | |
| # env: | |
| # GIT_USER: "github-actions[bot]" | |
| # GIT_EMAIL: "github-actions[bot]@users.noreply.github.com" | |
| # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| # run: | | |
| # git config --global user.name "$GIT_USER" | |
| # git config --global user.email "$GIT_EMAIL" | |
| # git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/dave-Lab-and-Engineering/python-build-utils.git | |
| # uv run mkdocs gh-deploy --force --remote-branch gh-pages | |