Skip to content

Add workflow_dispatch event to CI for granular workflow control #8822

@50-Course

Description

@50-Course

Checklist

  • I have checked the issues list
    for similar or identical enhancement to an existing feature.
  • I have checked the pull requests list
    for existing proposed enhancements.
  • I have checked the commit log
    to find out if the if the same enhancement was already implemented in the
    main branch.
  • I have included all related issues and possible duplicate issues in this issue
    (If there are none, check this box anyway).

Related Issues and Possible Duplicates

Related Issues

  • None

Possible Duplicates

  • None

Brief Summary

This proposal aims to enhance the CI infrastructure by adding the workflow_dispatch event. This event will enable finer-grained control over workflow execution, allowing developers to trigger individual workflows directly from the CLI. This capability will be particularly beneficial for debugging purposes, as it will facilitate isolating and troubleshooting failing workflows more efficiently.

Design

Architectural Considerations

  • The workflow_dispatch event will be implemented using GitHub Actions.

  • A new workflow will be defined specifically for handling dispatch events.

  • The dispatch workflow will accept input parameters specifying the target workflow to be triggered.

  • Security measures will be implemented to restrict access to the dispatch workflow and prevent unauthorized executions.

Proposed Behavior

  • Developers will be able to trigger individual workflows using the gh workflow dispatch command with the target workflow name as an argument.

  • The dispatch workflow will validate the provided workflow name and trigger the corresponding workflow run.

  • The triggered workflow will run with the same context and environment as a regular CI run.

Proposed UI/UX

  • No UI changes are directly associated with this proposal.

  • The addition of the workflow_dispatch event will primarily impact the CLI experience.

  • Documentation will be updated to provide instructions on using the gh workflow dispatch command.

Diagrams

N/A

Alternatives

None

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions