From c66cf77d7796bbf705c31ad037dd3f234a76060d Mon Sep 17 00:00:00 2001 From: Oliver Bertuch Date: Sun, 24 Sep 2023 12:21:57 +0200 Subject: [PATCH] Add autodoc action to transfer input/output documentation to README --- .github/workflows/autodoc-action.yml | 35 ++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/workflows/autodoc-action.yml diff --git a/.github/workflows/autodoc-action.yml b/.github/workflows/autodoc-action.yml new file mode 100644 index 0000000..b785930 --- /dev/null +++ b/.github/workflows/autodoc-action.yml @@ -0,0 +1,35 @@ +name: Update README.md with the latest actions.yml + +on: + push: + branches: + - main + +jobs: + update-doc: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 # otherwise, you will failed to push refs to dest repo + + - name: Run auto-doc + uses: tj-actions/auto-doc@v3 + + - name: Verify Changed files + uses: tj-actions/verify-changed-files@v8.6 + id: verify-changed-files + with: + files: | + README.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 README.md" + branch: "chore/auto-doc-update-readme" + commit-message: "auto-doc: Updated README.md" + body: "auto-doc: Updated README.md" \ No newline at end of file