From 8f7047f20807ec504a9ecf066074efb95c5222d1 Mon Sep 17 00:00:00 2001 From: Sebastian Romero Date: Mon, 19 Aug 2024 13:59:53 +0200 Subject: [PATCH] Add docs rendering workflow --- .github/workflows/render-docs.yml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/render-docs.yml diff --git a/.github/workflows/render-docs.yml b/.github/workflows/render-docs.yml new file mode 100644 index 0000000..29891f1 --- /dev/null +++ b/.github/workflows/render-docs.yml @@ -0,0 +1,29 @@ +name: Render Documentation + +on: + push: + branches: + - main + paths: + - ".github/workflows/render-documentation.ya?ml" + - "examples/**" + - "src/**" + pull_request: + branches: + - main + paths: + - ".github/workflows/render-documentation.ya?ml" + - "examples/**" + - "src/**" + workflow_dispatch: + +jobs: + render-docs: + permissions: + contents: write + uses: arduino/render-docs-github-action/.github/workflows/render-docs.yml@main + with: + source-path: './src' + target-path: './docs/api.md' + commit: ${{ github.event_name != 'pull_request' }} # Only commit changes if not a PR + \ No newline at end of file