Update docs to match exclusive end_time implementation #1230
Workflow file for this run
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 | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: ["*"] | |
| jobs: | |
| docs-home: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| lfs: true | |
| - run: corepack enable | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20.x | |
| cache: yarn | |
| - run: yarn install --immutable | |
| - run: yarn workspace website lint:ci | |
| - run: yarn workspace website typecheck | |
| - run: yarn workspace website build | |
| - run: yarn typedoc --out website/build/docs/typescript | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: public | |
| path: website/build | |
| retention-days: 1 | |
| docs-cpp: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: make -C cpp ci-docs | |
| - run: tar -czf docs-cpp.tgz __docs__/cpp | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-cpp | |
| path: docs-cpp.tgz | |
| retention-days: 1 | |
| docs-python: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.8 | |
| - run: pip install pipenv | |
| - run: make -C python docs | |
| - run: tar -czf docs-python.tgz __docs__/python | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-python | |
| path: docs-python.tgz | |
| retention-days: 1 | |
| docs-swift: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: swift-actions/setup-swift@v2 | |
| with: | |
| swift-version: "5.7" | |
| - run: mkdir __docs__ | |
| - run: | | |
| swift package \ | |
| --allow-writing-to-directory __docs__ \ | |
| generate-documentation --target MCAP \ | |
| --output-path __docs__/swift \ | |
| --disable-indexing \ | |
| --transform-for-static-hosting \ | |
| --hosting-base-path docs/swift | |
| # https://github.com/actions/upload-artifact/issues/85 | |
| - run: tar -czf docs-swift.tgz __docs__/swift | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-swift | |
| path: docs-swift.tgz | |
| retention-days: 1 | |
| docs-deploy: | |
| runs-on: ubuntu-latest | |
| if: ${{ !github.event.pull_request.head.repo.fork && github.actor != 'dependabot[bot]' }} | |
| needs: | |
| - docs-home | |
| - docs-cpp | |
| - docs-python | |
| - docs-swift | |
| permissions: | |
| contents: read | |
| deployments: write | |
| steps: | |
| # need checkout so that cloudflare can detect git commit | |
| - uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| - name: Extract API docs | |
| run: | | |
| for f in docs-*/*.tgz; do | |
| (set -x; tar -xf $f) | |
| done | |
| mkdir -p public/docs | |
| mv -v __docs__/* public/docs | |
| - name: Deploy | |
| uses: cloudflare/pages-action@v1 | |
| with: | |
| accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} | |
| apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} | |
| gitHubToken: ${{ github.token }} | |
| branch: ${{ github.head_ref || github.ref_name }} | |
| projectName: mcap | |
| directory: public |