Skip to content

Document how to require approval before a workflow runs #43854

@jsoref

Description

@jsoref

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/how-tos/write-workflows/choose-when-workflows-run

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

Add a page "Require manual approval for a specific job"

Additional information

  1. Visit https://github.com/check-spelling-sandbox/super-duper-fishstick/settings/environments (or similar)
  2. Click New environment (or similar)
  3. Name it (for my example, I picked spelling)
  4. Check Required reviewers
  5. Fill in reviewers
    Image
  6. Save
  7. Update the workflow to include environment: as in https://github.com/check-spelling-sandbox/super-duper-fishstick/blob/1a6c62c10d1310abfeb58d5b15b73c57b2c768a3/.github/workflows/spelling.yml#L84

  1. When a workflow run is triggered, it will appear queued:
    Image
  2. Clicking the workflow run will yield something like:
    Image
  3. Clicking Review deployments yields an approval dialog:
    Image
  4. Check the environment and then click Approve and deploy
  5. The job will start running:
    Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the team

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions