feat: clarify rate-limit as per-user, rename fields, add max-in-progress for agent tasks#26153
Draft
feat: clarify rate-limit as per-user, rename fields, add max-in-progress for agent tasks#26153
Conversation
…r agent tasks - Update rate-limit schema description to clearly say 'per-user workflow rate limit' - Update max/window/events/ignored-roles field descriptions to reference 'per-user' - Add max-in-progress field to limit concurrent in-progress GitHub agent tasks - Add MaxInProgress field to RateLimitConfig Go struct - Extract max-in-progress in extractRateLimitConfig - Pass GH_AW_RATE_LIMIT_MAX_IN_PROGRESS env var in generateRateLimitCheck - Add issues: read permission when max-in-progress is set - Add NewPermissionsContentsReadIssuesRead factory function - Implement max-in-progress check in check_rate_limit.cjs using agent tasks API Agent-Logs-Url: https://github.com/github/gh-aw/sessions/36ab6d0c-9ada-4759-84ed-248230cc118e Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
… instead of returning early Agent-Logs-Url: https://github.com/github/gh-aw/sessions/36ab6d0c-9ada-4759-84ed-248230cc118e Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
pelikhan
April 14, 2026 04:08
View session
pelikhan
reviewed
Apr 14, 2026
| "description": "Per-user workflow rate limit configuration to restrict how frequently individual users can trigger this workflow. Helps prevent abuse and resource exhaustion from programmatically triggered events. Optionally also limits the total number of in-progress GitHub agent tasks for the repository.", | ||
| "required": ["max"], | ||
| "properties": { | ||
| "max": { |
Collaborator
There was a problem hiding this comment.
- rename max to "max-runs-per-user" to be clearer.
- rename window to "max-runs-per-user-window"
- add codemod to fix those fields
Contributor
Author
There was a problem hiding this comment.
Done in commit 406da21:
- Renamed
rate-limit.max→rate-limit.max-runs-per-user - Renamed
rate-limit.window→rate-limit.max-runs-per-user-window - Added
rate-limit-fields-migrationcodemod (gh aw fix) that auto-renames both fields in existing workflow files - Backward-compat fallback kept in the compiler so old field names still work until
gh aw fixis run
- Rename rate-limit.max -> rate-limit.max-runs-per-user in schema, Go struct, and extraction logic - Rename rate-limit.window -> rate-limit.max-runs-per-user-window - Keep backward-compat fallback in extractRateLimitConfig for both old field names - Add codemod_rate_limit_fields.go with getRateLimitFieldsCodemod() to auto-rename fields - Register new codemod in GetAllCodemods() - Update fix_codemods_test.go count and expected order - Update all workflow .md files using rate-limit to new field names - Update test content in rate_limit_experimental_warning_test.go Agent-Logs-Url: https://github.com/github/gh-aw/sessions/ef79c11f-42ae-4ead-a817-c789b247832b Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot
AI
changed the title
feat: clarify rate-limit as per-user and add max-in-progress field for agent tasks
feat: clarify rate-limit as per-user, rename fields, add max-in-progress for agent tasks
Apr 14, 2026
This was referenced Apr 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the
rate-limitfrontmatter field with three changes:1. Clearer per-user semantics
Updated all descriptions in the JSON schema and Go code to explicitly state that
rate-limitis a per-user rate limit — each user is tracked independently. Fields updated:rate-limit(top-level description),max-runs-per-user,max-runs-per-user-window,events,ignored-roles.2. Renamed fields for clarity
rate-limit.max→rate-limit.max-runs-per-userrate-limit.window→rate-limit.max-runs-per-user-windowBackward-compatible: the compiler still accepts the old field names until
gh aw fixis run. A newrate-limit-fields-migrationcodemod (registered ingh aw fix) automatically renames them in existing workflow files.3. New
max-in-progressfieldAdded a new optional
max-in-progressfield to therate-limitconfiguration. This field limits the total number of in-progress GitHub agent tasks for the repository. If the number of currently in-progress tasks meets or exceeds this value, the current workflow run is cancelled.Example:
Implementation details:
GET /repos/{owner}/{repo}/agent/tasks?status=in_progress) with API version2026-03-10issues: readpermission (automatically added to the pre-activation job whenmax-in-progressis configured)Files Changed
pkg/parser/schemas/main_workflow_schema.jsonmax/windowfields; updated descriptions; addedmax-in-progressfieldpkg/workflow/frontmatter_types.goRateLimitConfigstruct JSON tags; addedMaxInProgressfieldpkg/workflow/role_checks.gopkg/workflow/compiler_pre_activation_job.goissues: readwhenmax-in-progressis setpkg/workflow/permissions_factory.goNewPermissionsContentsReadIssuesReadfactoryactions/setup/js/check_rate_limit.cjsmax-in-progresscheck using agent tasks APIpkg/cli/codemod_rate_limit_fields.gorate-limit-fields-migrationcodemodpkg/cli/fix_codemods.go.github/workflows/*.md