From c74ed4d92636e606dfff7754204cb9c564a31fa2 Mon Sep 17 00:00:00 2001 From: Sebastian Romero Date: Wed, 27 Nov 2024 09:39:35 +0100 Subject: [PATCH] Add API docs workflow --- .github/workflows/render-documentation.yml | 29 ++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/render-documentation.yml diff --git a/.github/workflows/render-documentation.yml b/.github/workflows/render-documentation.yml new file mode 100644 index 000000000..a4bfb6ee6 --- /dev/null +++ b/.github/workflows/render-documentation.yml @@ -0,0 +1,29 @@ +name: Render Documentation + +on: + push: + branches: + - main + paths: + - ".github/workflows/render-documentation.ya?ml" + - "./libraries/WiFiS3/examples/**" + - "./libraries/WiFiS3/src/**" + pull_request: + branches: + - main + paths: + - ".github/workflows/render-documentation.ya?ml" + - "./libraries/WiFiS3/examples/**" + - "./libraries/WiFiS3/src/**" + workflow_dispatch: + +jobs: + render-docs: + permissions: + contents: write + uses: arduino/render-docs-github-action/.github/workflows/render-docs.yml@main + with: + source-path: './libraries/WiFiS3/src' + target-path: './libraries/WiFiS3/docs/api.md' + exclude-pattern: 'StringHelpers.h WiFi.h Modem.h' + commit: ${{ github.event_name != 'pull_request' }} # Only commit changes if not a PR \ No newline at end of file