testing Cloudflare pages deploy #262
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: website | |
| # build the documentation whenever there are new commits on main | |
| on: | |
| push: | |
| paths: | |
| - '**.py' | |
| - 'README.md' | |
| # Alternative: only build for tags. | |
| # tags: | |
| # - '*' | |
| workflow_dispatch: | |
| inputs: | |
| message: | |
| description: 'Commit message' | |
| required: false | |
| default: 'Build documentation' | |
| # security: restrict permissions for CI jobs. | |
| permissions: | |
| contents: read | |
| jobs: | |
| # Build the documentation and upload the static HTML files as an artifact. | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.10' | |
| cache: "pip" | |
| - name: Install pdoc and dependencies | |
| # Install pdoc and dependencies | |
| run: | | |
| pip install pdoc | |
| pip install -r requirements.txt | |
| - name: Generate docs | |
| # Generate the documentation | |
| run: | | |
| pdoc orbi/ '!orbi.variables' utils/ -o docs | |
| - uses: actions/upload-pages-artifact@v1 | |
| with: | |
| path: docs/ | |
| - name: Publish to Cloudflare Pages | |
| uses: cloudflare/pages-action@v1 | |
| with: | |
| apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} | |
| accountId: 051a664b6faf179bb281cbc9c4725bcc | |
| projectName: orbi | |
| directory: docs/ | |
| # Optional: Enable this if you want to have GitHub Deployments triggered | |
| # gitHubToken: ${{ secrets.GITHUB_TOKEN }} | |
| # Deploy the artifact to GitHub pages. | |
| # This is a separate job so that only actions/deploy-pages has the necessary permissions. | |
| # ---------------------------------------------------------- | |
| # deploy: | |
| # needs: build | |
| # runs-on: ubuntu-latest | |
| # permissions: | |
| # pages: write | |
| # id-token: write | |
| # environment: | |
| # name: github-pages | |
| # url: ${{ steps.deployment.outputs.page_url }} | |
| # steps: | |
| # - id: deployment | |
| # uses: actions/deploy-pages@v1 | |
| # ---------------------------------------------------------- |