Skip to content

Commit

Permalink
ci: Add workflow dispatch to Build Docs (#773)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jnumainville authored Aug 29, 2024
1 parent c6c2dd2 commit bba5536
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions .github/workflows/build-main-docs.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -40,5 +66,5 @@ jobs:
secrets: inherit
with:
package: ${{ inputs.package }}
version: 'main'
version: ${{ inputs.version }}
event_name: ${{ inputs.event_name }}

0 comments on commit bba5536

Please sign in to comment.