Skip to content

docs: Add checkpoint-repo config documentation [doc-updater] - #654

Merged
jwbron merged 2 commits into
mainfrom
egg/doc-update-checkpoint-repo
Feb 14, 2026
Merged

docs: Add checkpoint-repo config documentation [doc-updater]#654
jwbron merged 2 commits into
mainfrom
egg/doc-update-checkpoint-repo

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

docs: Add checkpoint-repo config documentation [doc-updater]

Update documentation to reflect changes from 0d75976 (Add configurable checkpoint repo destination):

  • action/README.md: Document new checkpoint-repo input with example usage and EGG_CHECKPOINT_REPO variable configuration
  • config/README.md: Document checkpoint_repo setting in repo_settings with privacy and access control use cases

Changes

The recent commit added a checkpoint-repo input to the GitHub Action and checkpoint_repo setting to repository configuration, allowing checkpoints (session transcripts and tool call data) to be pushed to a separate repository instead of the source repo. This addresses privacy concerns by keeping checkpoint data out of the source repo's history.

These documentation updates ensure users can discover and configure this feature through both the Action input and local repository configuration.

Triggered by: 0d75976

Authored-by: egg

Update documentation to reflect changes from 0d75976 (Add configurable
checkpoint repo destination):

- action/README.md: Document new checkpoint-repo input with example
  usage and EGG_CHECKPOINT_REPO variable configuration
- config/README.md: Document checkpoint_repo setting in repo_settings
  with privacy and access control use cases

Triggered by: 0d75976

Authored-by: egg

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No agent-mode design concerns. This is a documentation-only change adding user-facing configuration docs for the checkpoint-repo feature — no agent workflows, prompts, or output formats are affected.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Documentation-only change. Verified accuracy against the implementation from 0d75976:

  • checkpoint-repo input exists in action/action.yml with matching description
  • generate-config.sh validates owner/repo format and writes checkpoint_repo to repositories.yaml
  • config/repo_config.py has get_checkpoint_repo() accessor as documented
  • checkpoint_handler.py consumes the setting correctly
  • repositories.yaml.example already has the commented-out example consistent with the docs
  • Branch name egg/checkpoints/v2 matches the code constant

The docs are accurate and well-placed (action README for CI users, config README for local users). No issues found.

One minor suggestion: the action/README.md example omits the github-token input, which the action requires (it just happens to have a default of ${{ github.token }}). Since the docs specifically state "The GitHub token must have write access to both repositories," it might be worth showing github-token explicitly in the checkpoint example to make it clear which token is being referenced — users who need cross-repo write access will likely need a PAT or App token rather than the default github.token. Not blocking on this since the existing action docs don't show github-token in other examples either.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@james-in-a-box

This comment has been minimized.

Add github-token to the checkpoint-repo example and clarify that
cross-repo checkpoints require a PAT or GitHub App token since the
default github.token is scoped to the current repository only.

Addresses review suggestion from egg-reviewer.
@james-in-a-box

Copy link
Copy Markdown
Contributor Author

Agreed. Added github-token: ${{ secrets.CROSS_REPO_TOKEN }} to the checkpoint example and clarified that the default github.token is scoped to the current repository, so cross-repo checkpoints require a PAT or GitHub App token. See 3dac67f.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Re-review: The delta (3dac67f) adds github-token to the checkpoint-repo example and clarifies cross-repo token requirements. Documentation-only change — no agent-mode design concerns.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Re-reviewed the delta since 11aacf5 (commit 3dac67f).

Previous feedback addressed: The suggestion to show github-token explicitly in the checkpoint example has been properly implemented. The example now includes github-token: ${{ secrets.CROSS_REPO_TOKEN }} and the accompanying text correctly explains that the default github.token is scoped to the current repository, so cross-repo checkpoints require a PAT or GitHub App token.

Verification of new changes:

  1. action/README.md: The github-token line is correctly placed in the YAML example. The explanatory text accurately describes the token scoping behavior. Consistent with action.yml where github-token defaults to ${{ github.token }}.

  2. Cross-checked against implementation:

    • action.yml: checkpoint-repo input exists with matching description and owner/repo format requirement.
    • generate-config.sh: Validates owner/repo format with regex before writing to config.
    • config/repo_config.py: get_checkpoint_repo() accessor exists and returns the setting correctly.
    • gateway/checkpoint_handler.py: Consumes checkpoint_repo with its own validation, uses egg/checkpoints/v2 branch as documented.
    • repositories.yaml.example: Has matching commented-out example.
  3. config/README.md: The checkpoint repository section (unchanged in this delta) remains accurate. The documented configuration methods (manual, GitHub Actions, runtime) all correspond to real code paths.

No issues found.

— Authored by egg

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg review completed. View run logs

5 previous review(s) hidden.

@jwbron
jwbron merged commit f696bb5 into main Feb 14, 2026
33 checks passed
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.

1 participant