diff --git a/docs/src/content/docs/reference/triggers.md b/docs/src/content/docs/reference/triggers.md index de00ae37212..d8ac15b4add 100644 --- a/docs/src/content/docs/reference/triggers.md +++ b/docs/src/content/docs/reference/triggers.md @@ -56,40 +56,15 @@ on: #### Accessing Inputs in Markdown -Use `${{ github.event.inputs.INPUT_NAME }}` expressions to access workflow_dispatch inputs in your markdown content: - -```aw wrap ---- -on: - workflow_dispatch: - inputs: - topic: - description: 'Research topic' - required: true - type: string - -permissions: - contents: read - -safe-outputs: - create-discussion: ---- - -# Research Assistant +Access inputs in your markdown content with `${{ github.event.inputs.INPUT_NAME }}`: +```markdown Research the following topic: "${{ github.event.inputs.topic }}" - -Provide a comprehensive summary with key findings and recommendations. ``` -**Supported input types:** - -- `string` - Free-form text input -- `boolean` - True/false checkbox -- `choice` - Dropdown selection with predefined options -- `environment` - Dropdown selection of GitHub environments configured in the repository +**Supported input types:** `string` (free-form text), `boolean` (checkbox), `choice` (dropdown with predefined options), and `environment` (dropdown populated from repository Settings → Environments). -The `environment` input type automatically populates a dropdown with environments configured in repository Settings → Environments. It returns the environment name as a string and supports a `default` value. Unlike the `manual-approval:` field, using an `environment` input does not enforce environment protection rules—it only provides the environment name as a string value for use in your workflow logic. +The `environment` input returns the environment name as a string and supports a `default` value. Unlike `manual-approval:`, it does not enforce environment protection rules — it only provides the environment name for use in your workflow logic. ### Scheduled Triggers (`schedule:`) @@ -97,25 +72,13 @@ Run workflows on a recurring schedule using human-friendly expressions or [cron **Fuzzy Scheduling:** -Use fuzzy schedules to automatically scatter execution times and avoid load spikes: - -```yaml wrap -on: - schedule: daily # Compiler assigns a unique scattered time per workflow -``` - -Use the `around` constraint for a preferred time with flexibility: +Fuzzy schedules scatter execution times to avoid load spikes. Use `around