Skip to content

[docs] docs: document --session-state-dir flag and AWF_SESSION_STATE_DIR env var#1600

Merged
Mossaka merged 1 commit intomainfrom
docs/sync-session-state-dir-flag-c9d98862e74634cc
Apr 2, 2026
Merged

[docs] docs: document --session-state-dir flag and AWF_SESSION_STATE_DIR env var#1600
Mossaka merged 1 commit intomainfrom
docs/sync-session-state-dir-flag-c9d98862e74634cc

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot commented Apr 2, 2026

Documentation Sync - 2026-03-26 to 2026-04-02

This PR synchronizes documentation with code changes from the past 7 days.

Changes Made

  • Updated docs/usage.md: Added --session-state-dir to the CLI options list (after --proxy-logs-dir), and expanded the Agent Session State description to explain the flag's timeout-safe, predictable-path behaviour and its usefulness for GitHub Actions artifact uploads.

  • Updated docs/environment.md: Added AWF_SESSION_STATE_DIR to the internal variables table and updated the note below the table to clarify that this variable is user-configurable (unlike the other internal-only variables).

Code Changes Referenced

  • Commit 6536923: fix: capture full session state — replace blanket ~/.copilot mount, add --session-state-dir (#1593) — introduced the --session-state-dir CLI flag and AWF_SESSION_STATE_DIR environment variable; neither was reflected in the documentation prior to this PR.

Verification

  • --session-state-dir matches src/cli.ts:1419 option registration
  • AWF_SESSION_STATE_DIR matches src/cli.ts:1733 env var lookup
  • Flag description matches src/cli.ts:1421 ("Directory to save Copilot CLI session state")
  • Consistent with existing --proxy-logs-dir documentation style
  • Links checked — no new external links added

AI generated by Documentation Maintainer

… var

Add the --session-state-dir CLI flag and AWF_SESSION_STATE_DIR environment
variable to the documentation, introduced in #1593.

- docs/usage.md: add --session-state-dir to the CLI options list (after
  --proxy-logs-dir), and expand the Agent Session State description to
  mention the flag's timeout-safe, predictable-path behaviour useful for
  GitHub Actions artifact uploads
- docs/environment.md: add AWF_SESSION_STATE_DIR to the internal variables
  table and update the note to clarify it is user-configurable

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions bot requested a review from Mossaka as a code owner April 2, 2026 06:55
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 2, 2026
@Mossaka Mossaka merged commit 0750659 into main Apr 2, 2026
@Mossaka Mossaka deleted the docs/sync-session-state-dir-flag-c9d98862e74634cc branch April 2, 2026 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-generated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant