Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Feb 12, 2026

The environment input type exists in the schema and is tested but lacks user-facing documentation, causing confusion about its behavior and relationship to manual-approval:.

Changes

  • DispatchOps pattern doc: Added dedicated section explaining environment input type behavior, characteristics, and usage with examples
  • Triggers reference: Added environment input type to supported types list with clarifying description
  • Key clarification: Documented that environment input provides environment name selection only, not protection rule enforcement (which is manual-approval:'s purpose)

Example

on:
  workflow_dispatch:
    inputs:
      target_env:
        description: 'Deployment target'
        required: true
        type: environment        # Auto-populated dropdown from repo environments
        default: staging

The environment input type:

  • Auto-populates from repository Settings → Environments
  • Returns environment name as string (no options: list needed)
  • Does NOT enforce environment protection rules

Access in markdown: ${{ github.event.inputs.target_env }}

Original prompt

This section details on the original issue you should resolve

<issue_title>[deep-report] Document workflow_dispatch environment input type</issue_title>
<issue_description>### Description
Document the environment input type for workflow_dispatch inputs in the reference docs so users understand it is supported and how it behaves. The schema includes the value and tests reference it, but documentation is missing.

Expected Impact

Reduced user confusion and fewer invalid configurations; improved schema-to-doc consistency.

Suggested Agent

Documentation-focused agent

Estimated Effort

Fast (< 30 min)

Data Source

DeepReport Intelligence Briefing - 2026-02-11 (schema consistency discussion #14906)

AI generated by DeepReport - Intelligence Gathering Agent

  • expires on Feb 13, 2026, 3:36 PM UTC

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits February 12, 2026 00:19
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
- Added detailed explanation of environment input type in DispatchOps pattern doc
- Updated triggers reference with environment input type description
- Added examples showing environment input usage
- Clarified difference between environment input and manual-approval field

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Document workflow_dispatch environment input type Document workflow_dispatch environment input type Feb 12, 2026
Copilot AI requested a review from pelikhan February 12, 2026 00:23
@pelikhan pelikhan marked this pull request as ready for review February 12, 2026 00:27
Copilot AI review requested due to automatic review settings February 12, 2026 00:27
@pelikhan pelikhan merged commit 5d45687 into main Feb 12, 2026
2 checks passed
@pelikhan pelikhan deleted the copilot/document-workflow-dispatch-input branch February 12, 2026 00:27
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation for the environment input type in workflow_dispatch triggers, which was previously supported in the schema and tests but lacked user-facing documentation.

Changes:

  • Added detailed documentation explaining the environment input type's behavior, characteristics, and relationship to manual-approval: in the DispatchOps pattern guide
  • Updated the triggers reference to include environment in the supported input types list with clarifying description
  • Lock file updates that add GH_AW_RATE_LIMIT_IGNORED_ROLES environment variable to workflows with rate-limit configurations (expected compilation behavior)

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/src/content/docs/reference/triggers.md Added environment input example and expanded description in supported input types list
docs/src/content/docs/patterns/dispatchops.md Added dedicated "Environment Input Type" section with characteristics, usage examples, and clarification about manual-approval
.github/workflows/workflow-generator.lock.yml Added GH_AW_RATE_LIMIT_IGNORED_ROLES env var (compilation default for rate-limit)
.github/workflows/example-custom-error-patterns.lock.yml Added GH_AW_RATE_LIMIT_IGNORED_ROLES env var (compilation default for rate-limit)
.github/workflows/auto-triage-issues.lock.yml Added GH_AW_RATE_LIMIT_IGNORED_ROLES env var (compilation default for rate-limit)
.github/workflows/ai-moderator.lock.yml Added GH_AW_RATE_LIMIT_IGNORED_ROLES env var (compilation default for rate-limit)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[deep-report] Document workflow_dispatch environment input type

2 participants