docs: add example usage of pypi publish workflow #15
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: GH Workflow Docs | |
| on: | |
| push: | |
| branches: [main] | |
| jobs: | |
| gen_workflow_docs: | |
| name: Auto Doc | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Document doxygen_build | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/doxygen_build.yml | |
| output: docs/doxygen_build.md | |
| - name: Document image_build | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/image_build.yml | |
| output: docs/image_build.md | |
| - name: Document mkdocs_build | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/mkdocs_build.yml | |
| output: docs/mkdocs_build.md | |
| - name: Document pypi_publish | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/pypi_publish.yml | |
| output: docs/pypi_publish.md | |
| - name: Document wiki | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/wiki.yml | |
| output: docs/wiki.md | |
| - name: Verify Changed files | |
| uses: tj-actions/[email protected] | |
| id: verify-changed-files | |
| with: | |
| files: | | |
| docs/doxygen_build.md | |
| docs/mkdocs_build.md | |
| docs/pypi_publish.md | |
| docs/wiki.md | |
| - name: Create Pull Request | |
| if: steps.verify-changed-files.outputs.files_changed == 'true' | |
| uses: peter-evans/create-pull-request@v3 | |
| with: | |
| base: "main" | |
| title: "auto-doc: updated workflows docs" | |
| branch: "docs/auto-doc-update-workflows" | |
| commit-message: "docs: updated workflow docs" | |
| body: "PR triggered via workflow_docs.yml workflow." |