Skip to content

fix(docs): Add environment input type for workflow_dispatch #29781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 14, 2023
Merged

fix(docs): Add environment input type for workflow_dispatch #29781

merged 5 commits into from
Nov 14, 2023

Conversation

FidelusAleksander
Copy link
Contributor

@FidelusAleksander FidelusAleksander commented Nov 5, 2023

Why:

Environment input type is supported for workflow_dispatch event triggers for a long time. It's confusing that it isn't in this part of the documentation.

It was there before but was wrongly removed in #25436

Related to: #25938
Closes: #25938

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 5, 2023
@FidelusAleksander FidelusAleksander changed the title Add environment input type for workflow_dispatch fix(docs): Add environment input type for workflow_dispatch Nov 5, 2023
Copy link
Contributor

github-actions bot commented Nov 5, 2023

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/using-workflows/workflow-syntax-for-github-actions.md fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae
fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21
Copy link
Contributor

@FidelusAleksander Thanks so much for submitting a PR! I'll get this triaged for review ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Nov 6, 2023
@garysassano
Copy link
Contributor

From the github-workflow schema:

"type": {
  "description": "A string representing the type of the input.",
  "$comment": "https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#onworkflow_dispatchinputsinput_idtype",
  "type": "string",
  "enum": [
    "string",
    "choice",
    "boolean",
    "number",
    "environment"
  ]
},

Copy link
Contributor

@SiaraMist SiaraMist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for fixing this @FidelusAleksander! ⚡ Our repository is currently frozen during GitHub Universe, but I'll add the Merge after freeze label and we should get your PR merged next week.

@SiaraMist SiaraMist added ready to merge This pull request is ready to merge Merge-after-freeze and removed waiting for review Issue/PR is waiting for a writer's review labels Nov 7, 2023
@cmwilson21 cmwilson21 enabled auto-merge November 14, 2023 15:06
@cmwilson21 cmwilson21 added this pull request to the merge queue Nov 14, 2023
Merged via the queue into github:main with commit d470100 Nov 14, 2023
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team ready to merge This pull request is ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[GitHub Actions] environment type missing in workflow input types documentation
4 participants