[docs] Update documentation for features from 2025-10-28#2670
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
Agentic Changeset Generator triggered by this pull request. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation to reflect four features merged on 2025-10-28: the --zizmor security scanning flag for the compile command, strict mode enforcement with zizmor, clarification of stop-after time unit requirements (no minute-only units), and the new max_tokens parameter for MCP logs output guardrails.
- Added
--zizmorflag documentation for security scanning with zizmor integration - Documented strict mode behavior treating zizmor findings as compilation errors
- Clarified that minute-only time units (e.g.,
+30m) are not allowed instop-after - Added
max_tokensparameter documentation for MCP logs output size control
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/src/content/docs/tools/cli.md | Documents --zizmor flag and strict mode enforcement for security scanning |
| docs/src/content/docs/reference/triggers.md | Clarifies stop-after time unit requirements excluding minute-only units |
| docs/src/content/docs/reference/frontmatter-full.md | Adds note about minute-only units not being allowed in stop-after |
| docs/src/content/docs/tools/mcp-server.md | Documents max_tokens parameter for logs output guardrail with schema and jq examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| Accepts absolute dates (`YYYY-MM-DD`, `MM/DD/YYYY`, `DD/MM/YYYY`, `January 2 2006`, `1st June 2025`, ISO 8601) or relative deltas (`+7d`, `+25h`, `+1d12h`) calculated from compilation time. The minimum unit for relative deltas is hours (`h`). Recompiling the workflow resets the stop time. | ||
| Accepts absolute dates (`YYYY-MM-DD`, `MM/DD/YYYY`, `DD/MM/YYYY`, `January 2 2006`, `1st June 2025`, ISO 8601) or relative deltas (`+7d`, `+25h`, `+1d12h30m`) calculated from compilation time. The minimum granularity is hours - minute-only units (e.g., `+30m`) are not allowed. Recompiling the workflow resets the stop time. |
There was a problem hiding this comment.
The statement 'The minimum granularity is hours' contradicts the example +1d12h30m which includes minutes. Either remove the minutes from the example or revise the explanation to clarify that minutes can be used in combination with hours/days but not alone.
| Accepts absolute dates (`YYYY-MM-DD`, `MM/DD/YYYY`, `DD/MM/YYYY`, `January 2 2006`, `1st June 2025`, ISO 8601) or relative deltas (`+7d`, `+25h`, `+1d12h30m`) calculated from compilation time. The minimum granularity is hours - minute-only units (e.g., `+30m`) are not allowed. Recompiling the workflow resets the stop time. | |
| Accepts absolute dates (`YYYY-MM-DD`, `MM/DD/YYYY`, `DD/MM/YYYY`, `January 2 2006`, `1st June 2025`, ISO 8601) or relative deltas (`+7d`, `+25h`, `+1d12h30m`) calculated from compilation time. The minimum granularity is hours—minute-only units (e.g., `+30m`) are not allowed, but minutes can be used in combination with hours or days (e.g., `+1d12h30m`). Recompiling the workflow resets the stop time. |
Updates documentation for four features merged in the last 24 hours:
--zizmorsecurity scanning flag, strict mode enforcement with zizmor,stop-aftertime unit restrictions, and MCP logsmax_tokensparameter.Changes
CLI Documentation (
docs/src/content/docs/tools/cli.md)--zizmorflag for running security scanner on compiled workflowsTrigger Reference (
docs/src/content/docs/reference/triggers.md,frontmatter-full.md)stop-afterminimum granularity is hours; minute-only units like+30mare rejected+1d12h30mremain validMCP Server Documentation (
docs/src/content/docs/tools/mcp-server.md)max_tokensparameter for logs tool (default: 12,000 tokens){ "name": "logs", "arguments": { "count": 100, "max_tokens": 20000 } }Referenced PRs
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:
telemetry.astro.buildnode /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
This section details on the original issue you should resolve
<issue_title>[docs] Update documentation for features from 2025-10-28</issue_title>
<issue_description>## Documentation Updates - 2025-10-28
This PR updates the documentation based on features merged in the last 24 hours.
Features Documented
--zizmorflag for compile command (from Add --zizmor flag to compile command for security scanning #2639)Strict mode + zizmor enforcement (from Add strict mode enforcement for zizmor security findings #2652)
--strict --zizmorcombinationstop-aftertime unit clarification (from Reject minute units in stop-after relative time deltas #2611)+30m) are not allowedMCP logs
max_tokensparameter (from Add token-based output guardrail to MCP server logs command with configurable limit #2616)Changes Made
docs/src/content/docs/tools/cli.mdto document--zizmorflag and strict mode behaviordocs/src/content/docs/reference/triggers.mdto clarifystop-aftertime unit requirementsdocs/src/content/docs/reference/frontmatter-full.mdto add note about minute-only unitsdocs/src/content/docs/tools/mcp-server.mdto documentmax_tokensparameter and output guardrailMerged PRs Referenced
Additional Notes
toolsetsrename (from Renametoolsettotoolsetsin GitHub tool configuration #2648) was already documented in docs: Recommend GitHub MCP Server toolsets over individual allowed tools #2647persist-credentials: falsewith actions/checkout #2641, Remove github.actor and github.workflow from allowed expressions #2642, Set detection job to explicit empty permissions #2644, Fix push-to-pull-request-branch error handling and log truncation issues #2656) did not require user-facing documentation updates🤖 Generated with Claude Code
Show patch preview (119 of 119 lines)