Skip to content

Unnecessary and duplicate workflow-dispatch-inputs-example.md file #24501

@Aashu-Dubey

Description

@Aashu-Dubey

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#onworkflow_dispatchinputs
https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#defining-inputs-for-manually-triggered-workflows

What part(s) of the article would you like to see updated?

Going through the docs, I noticed that the example used to define inputs for manually triggered workflows is duplicate and serves no extra purpose.

Looking at the docs this extra example comes from file workflow-dispatch-inputs-example.md and was just added last month for some reason.

So my proposed fix for this would be

  1. delete the file workflow-dispatch-inputs-example.md, as if we search for this file, it is only being used in 2 places, and on both of them it is only working as a duplicate, and workflow-dispatch-inputs.md seems to be useful as it also contains come extra common content.
    or
    Instead of deleting it, update the yaml part of the code in workflow-dispatch-inputs.md file with this
{% data reusables.actions.workflow-dispatch-inputs-example %}
  1. Delete these lines from workflow-syntax-for-github-actions.md file.
    Not sure if the text Example of on.workflow_dispatch.inputs is important so you can confirm on that.
  2. Delete this line from triggering-a-workflow.md file.

Additional information

If you look at the video, except spacing of options values, both are same example

github_docs_example_issue.mp4

I'd be more than happy to contribute a PR if you confirm 🙏🏼

Metadata

Metadata

Assignees

No one assigned

    Labels

    actionsThis issue or pull request should be reviewed by the docs actions teamcontentThis issue or pull request belongs to the Docs Content teamhelp wantedAnyone is welcome to open a pull request to fix this issuewaiting for reviewIssue/PR is waiting for a writer's review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions