DiamondLightSource / DiamondLightSource/httomo

Unnecessary `workflow_dispatch` in docs github action workflow?

Open
#391 0 comments 0 reactions 0 assignees View on GitHub
ci question
Dominant language
Python
Stars
10
Forks
5
Avg merge
5d 17h
Merged PRs (30d)
1

Description

Through browsing the github actions tab and trying to learn more about how workflows are configured, I came across this for the workflow doing the docs build
![Screenshot from 2024-07-16 18-22-06](https://github.com/user-attachments/assets/8b5b2824-f98e-421d-82f0-bb4d1d5e3bc1)

This seems to be due to the `workflow_dispatch` field in the workflow file: https://github.com/DiamondLightSource/httomo/blob/eb0e5b5aa2db2e307acb5482e1bd5a080753f800/.github/workflows/doc_conda.yml#L4

From the [docs](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow), this appears to be a feature to allow manually running a workflow.

Just wanted to ask if this is intentional: do we need to be able to run the docs building manually?

Contributor guide

No contributing guide indexed for this repository

Research direction

Read .github/workflows/doc_conda.yml around line 4 and compare the workflow trigger with GitHub's documentation for manually running workflows. Determine whether manual documentation builds are needed; done means the decision is recorded and the workflow configuration matches that decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.