Update documentation #8
This file contains hidden or 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: Update documentation | |
| on: | |
| schedule: | |
| # Run weekly on Monday at 8:00 AM UTC | |
| - cron: '0 8 * * 1' | |
| workflow_dispatch: | |
| # Allow manual triggering | |
| jobs: | |
| update-docs: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| cache: 'pip' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| if [ -f scripts/requirements.txt ]; then | |
| pip install -r scripts/requirements.txt | |
| else | |
| # Install minimum required packages if no requirements.txt exists | |
| pip install jinja2 pyyaml | |
| fi | |
| - name: Run documentation generator | |
| run: | | |
| cd scripts | |
| python render_md.py | |
| - name: Check for changes | |
| id: git-check | |
| run: | | |
| git diff --exit-code || echo "changes=true" >> $GITHUB_OUTPUT | |
| - name: Create Pull Request | |
| if: steps.git-check.outputs.changes == 'true' | |
| uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v5 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| commit-message: "docs: update generated documentation" | |
| title: "Update generated documentation" | |
| body: | | |
| This PR updates the generated documentation based on the latest data. | |
| - Updates component tables | |
| - Updates SDK feature tables | |
| - Updates OCB file | |
| This is an automated PR created by the documentation update workflow. | |
| branch: update-docs | |
| base: main | |
| delete-branch: true | |
| labels: | | |
| documentation | |
| automated-pr |