Command PrDoc #19
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: Command PrDoc | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| pr: | |
| type: number | |
| description: Number of the Pull Request | |
| required: true | |
| bump: | |
| type: choice | |
| description: Default bump level for all crates | |
| default: "TODO" | |
| required: true | |
| options: | |
| - "TODO" | |
| - "no change" | |
| - "patch" | |
| - "minor" | |
| - "major" | |
| audience: | |
| type: choice | |
| description: Audience of the PrDoc | |
| default: "TODO" | |
| required: true | |
| options: | |
| - "TODO" | |
| - "Runtime Dev" | |
| - "Runtime User" | |
| - "Node Dev" | |
| - "Node Operator" | |
| overwrite: | |
| type: choice | |
| description: Overwrite existing PrDoc | |
| default: "true" | |
| required: true | |
| options: | |
| - "true" | |
| - "false" | |
| concurrency: | |
| group: command-prdoc | |
| cancel-in-progress: true | |
| jobs: | |
| preflight: | |
| uses: ./.github/workflows/reusable-preflight.yml | |
| cmd-prdoc: | |
| needs: [preflight] | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 20 | |
| container: | |
| image: ${{ needs.preflight.outputs.IMAGE }} | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| steps: | |
| - name: Download repo | |
| uses: actions/checkout@v4 | |
| - name: Install gh cli | |
| id: gh | |
| uses: ./.github/actions/set-up-gh | |
| with: | |
| pr-number: ${{ inputs.pr }} | |
| GH_TOKEN: ${{ github.token }} | |
| - name: Generate PrDoc | |
| run: | | |
| python3 -m pip install -q cargo-workspace PyGithub whatthepatch pyyaml toml | |
| python3 .github/scripts/generate-prdoc.py --pr "${{ inputs.pr }}" --bump "${{ inputs.bump }}" --audience "${{ inputs.audience }}" --force "${{ inputs.overwrite }}" | |
| - name: Report failure | |
| if: ${{ failure() }} | |
| run: gh pr comment ${{ inputs.pr }} --body "<h2>Command failed ❌</h2> Run by @${{ github.actor }} for <code>${{ github.workflow }}</code> failed. See logs <a href=\"$RUN\">here</a>." | |
| env: | |
| RUN: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} | |
| GH_TOKEN: ${{ github.token }} | |
| - name: Push Commit | |
| uses: stefanzweifel/git-auto-commit-action@v5 | |
| with: | |
| commit_message: Add PrDoc (auto generated) | |
| branch: ${{ steps.gh.outputs.branch }} | |
| file_pattern: 'prdoc/*.prdoc' |