philipbalbas is generating documentation #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
| name: Generate docs on merge to dev | |
| run-name: ${{ github.actor }} is generating documentation | |
| on: | |
| push: | |
| branches: | |
| - "dev" | |
| - "main" | |
| jobs: | |
| Generate-Docs-For-TS-SDK: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20.x" | |
| - name: Cache npm dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: sdks/ts/node_modules | |
| key: ${{ runner.os }}-sdks-ts-npm-${{ hashFiles('sdks/ts/package-lock.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-sdks-ts-npm- | |
| - name: Install npm dependencies | |
| run: | | |
| cd sdks/ts | |
| npm ci | |
| - name: Generate docs | |
| run: | | |
| cd sdks/ts | |
| npm run generate-docs | |
| - uses: stefanzweifel/git-auto-commit-action@v4 | |
| with: | |
| commit_message: "doc(sdks/ts): Generate docs for sdks/ts (CI)" | |
| branch: ${{ github.head_ref }} | |
| Generate-Docs-For-Python-SDK: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: Install and configure Poetry | |
| uses: snok/install-poetry@v1 | |
| - name: Configure Poetry to use .venv | |
| run: | | |
| cd sdks/python | |
| poetry config virtualenvs.in-project true | |
| - name: Cache Poetry virtualenv | |
| uses: actions/cache@v4 | |
| with: | |
| path: sdks/python/.venv | |
| key: ${{ runner.os }}-sdks-python-poetry-${{ hashFiles('sdks/python/poetry.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-sdks-python-poetry- | |
| - name: Cache pytype | |
| uses: actions/cache@v4 | |
| with: | |
| path: sdks/python/.pytype | |
| key: ${{ runner.os }}-sdks-python-pytype-${{ hashFiles('sdks/python/**/*.py') }} | |
| restore-keys: | | |
| ${{ runner.os }}-sdks-python-pytype- | |
| - name: Install dependencies | |
| run: | | |
| cd sdks/python | |
| poetry install | |
| - name: Generate docs | |
| run: | | |
| cd sdks/python | |
| poetry run poe doc | |
| - uses: stefanzweifel/git-auto-commit-action@v4 | |
| with: | |
| commit_message: "doc(sdks/python): Generate docs for sdks/python (CI)" | |
| branch: ${{ github.head_ref }} | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true |