docs(usage): add for pipx #20
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 Website | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - docs/** | |
| - requests/** | |
| - sample-configs/** | |
| - jsfh-conf.yaml | |
| - mkdocs.yml | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: 'pages' | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| enable-cache: true | |
| cache-dependency-glob: 'pyproject.toml' | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version-file: '.python-version' | |
| cache: 'pip' | |
| cache-dependency-path: 'pyproject.toml' | |
| - uses: extractions/setup-just@v2 | |
| - name: Install deps | |
| run: just restore-env | |
| - name: Install new cpn-cli | |
| run: uv add --upgrade cpn-cli | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v5 | |
| - name: Build website | |
| run: just build-web | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: 'site' | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| permissions: | |
| pages: write # to deploy to Pages | |
| id-token: write # to verify the deployment originates from an appropriate source | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |