build: relock python deps using inherit_metadata strategy #342
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 env_vars | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/env_vars.yml | |
| output: docs/env_vars.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 image_build_multi | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/image_build_multi.yml | |
| output: docs/image_build_multi.md | |
| - name: Document image_artifact | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/image_artifact.yml | |
| output: docs/image_artifact.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 npm_publish | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/npm_publish.yml | |
| output: docs/npm_publish.md | |
| - name: Document openapi_build | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/openapi_build.yml | |
| output: docs/openapi_build.md | |
| - name: Document py_app_version | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/py_app_version.yml | |
| output: docs/py_app_version.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 remote_deploy_compose | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/remote_deploy_compose.yml | |
| output: docs/remote_deploy_compose.md | |
| - name: Document pnpm_build | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/pnpm_build.yml | |
| output: docs/pnpm_build.md | |
| - name: Document test_pnpm | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/test_pnpm.yml | |
| output: docs/test_pnpm.md | |
| - name: Document test_compose | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/test_compose.yml | |
| output: docs/test_compose.md | |
| - name: Document test_pytest | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/test_pytest.yml | |
| output: docs/test_pytest.md | |
| - name: Document wiki | |
| uses: tj-actions/auto-doc@v3 | |
| with: | |
| reusable: true | |
| filename: .github/workflows/wiki.yml | |
| output: docs/wiki.md | |
| - name: Run pre-commit hooks | |
| run: | | |
| pip install pre-commit | |
| # Don't send exit code | |
| pre-commit run --all-files || true | |
| - name: Verify Changed Files | |
| uses: tj-actions/verify-changed-files@v20 | |
| id: verify-changed-files | |
| with: | |
| files: | | |
| docs/*.md | |
| - name: Create Pull Request | |
| if: steps.verify-changed-files.outputs.files_changed == 'true' | |
| uses: peter-evans/create-pull-request@v6 | |
| 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." |