From bba5536ffe45065a06c5ca089093d39420f77eef Mon Sep 17 00:00:00 2001 From: Joe Date: Thu, 29 Aug 2024 11:37:00 -0500 Subject: [PATCH] ci: Add workflow dispatch to Build Docs (#773) Fixes #724 Have tested on my own fork. Adds a workflow dispatch to `build-main-docs.yml`. It's in a slightly funky spot because release docs are automatically synced separately in a different workflow, but this could still be used to sync docs from a specific release, without actually releasing the package itself. --- .github/workflows/build-main-docs.yml | 30 +++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build-main-docs.yml b/.github/workflows/build-main-docs.yml index a9ac4c576..29b74c3c7 100644 --- a/.github/workflows/build-main-docs.yml +++ b/.github/workflows/build-main-docs.yml @@ -1,12 +1,38 @@ -name: Build Main Docs +name: Build Docs on: + workflow_dispatch: + inputs: + package: + description: 'Name of the package to build docs for.' + required: true + type: choice + options: + - 'plotly-express' + - 'ui' + version: + description: 'Version of the package to build docs for. This only affects where the docs are synced and not the actual docs built so in most cases this should be "main".' + required: true + type: string + default: 'main' + event_name: + description: 'Event name to determine if the docs should be synced. Keep this as "push" to sync the docs.' + required: true + type: choice + default: 'push' + options: + - 'push' + - 'test' workflow_call: inputs: package: description: The plugin to publish the docs for required: true type: string + version: + description: The version of the plugin to publish the docs for + type: string + default: 'main' event_name: description: The event name that triggered the workflow required: true @@ -40,5 +66,5 @@ jobs: secrets: inherit with: package: ${{ inputs.package }} - version: 'main' + version: ${{ inputs.version }} event_name: ${{ inputs.event_name }}