📚 Generate docs #38
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: | |
| release: {} | |
| workflow_dispatch: {} | |
| env: | |
| # Used by GitHub CLI inside script for authenticating to GitHub | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| WORKFLOWS_PATH: ${{ github.workspace }}.github/workflows | |
| OUTPUT_PATH: ${{ github.workspace }}/docs/workflows | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| working-directory: scripts/actions-docs | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.10.12 | |
| - name: Install requirements | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| - name: Run script | |
| run: ./actions-docs.py -p "$WORKFLOWS_PATH" -o "$OUTPUT_PATH" | |
| - name: Create PR | |
| uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38 | |
| with: | |
| branch: actions-docs--branches--main | |
| add-paths: ${{ env.OUTPUT_PATH }} | |
| committer: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | |
| commit-message: "docs: update workflow usage" | |
| author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | |
| base: main | |
| title: "docs: update workflow usage" | |
| body: "" |