refactor(py/pytauri): rename methods of Commands
#21
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
| # copy from: https://github.com/frankie567/httpx-ws/blob/main/.github/workflows/docs.yml | |
| # WARNING: Do not change the name of this file, keep `docs.yml`. | |
| # markdown badges are hard-coded to point to this file. | |
| name: Deploy documentation | |
| # Since document updates may be frequent, | |
| # we do not run tests when deploying documents, | |
| # instead test during the PR stage. | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| # Allow only one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| # see: <https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/tree/2e7646ee3405d8793e5ebb83eb45f7aa9407b205?tab=readme-ov-file#note-when-using-build-systems-like-github-actions> | |
| fetch-depth: 0 | |
| - name: setup-envs-ver | |
| id: setup-envs-ver | |
| uses: ./.github/actions/setup-envs-ver | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v4 | |
| with: | |
| # see: <https://docs.astral.sh/uv/guides/integration/github/> | |
| version: ${{ steps.setup-envs-ver.outputs.uv }} | |
| enable-cache: true | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version-file: "pyproject.toml" | |
| - name: Build docs | |
| run: | | |
| uv run --only-group=docs --only-group=workspaces --all-extras -- mkdocs build | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./site | |
| deploy-docs: | |
| needs: build-docs | |
| # Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
| permissions: | |
| pages: write # to deploy to Pages | |
| id-token: write # to verify the deployment originates from an appropriate source | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |