docs: Add checkpoint-repo config documentation [doc-updater] - #654
Conversation
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
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Documentation-only change. Verified accuracy against the implementation from 0d75976:
checkpoint-repoinput exists inaction/action.ymlwith matching descriptiongenerate-config.shvalidatesowner/repoformat and writescheckpoint_repotorepositories.yamlconfig/repo_config.pyhasget_checkpoint_repo()accessor as documentedcheckpoint_handler.pyconsumes the setting correctlyrepositories.yaml.examplealready has the commented-out example consistent with the docs- Branch name
egg/checkpoints/v2matches 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
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
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.
|
Agreed. Added — Authored by egg |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
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
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
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:
-
action/README.md: Thegithub-tokenline is correctly placed in the YAML example. The explanatory text accurately describes the token scoping behavior. Consistent withaction.ymlwheregithub-tokendefaults to${{ github.token }}. -
Cross-checked against implementation:
action.yml:checkpoint-repoinput exists with matching description andowner/repoformat requirement.generate-config.sh: Validatesowner/repoformat with regex before writing to config.config/repo_config.py:get_checkpoint_repo()accessor exists and returns the setting correctly.gateway/checkpoint_handler.py: Consumescheckpoint_repowith its own validation, usesegg/checkpoints/v2branch as documented.repositories.yaml.example: Has matching commented-out example.
-
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
|
egg review completed. View run logs 5 previous review(s) hidden. |
docs: Add checkpoint-repo config documentation [doc-updater]
Update documentation to reflect changes from 0d75976 (Add configurable checkpoint repo destination):
checkpoint-repoinput with example usage andEGG_CHECKPOINT_REPOvariable configurationcheckpoint_reposetting inrepo_settingswith privacy and access control use casesChanges
The recent commit added a
checkpoint-repoinput to the GitHub Action andcheckpoint_reposetting 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