You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Archify already has stable JSON receipts and repository CI jobs, but contributors need a reusable example for validating diagrams, uploading receipts, producing trusted artifacts, and checking package freshness.
This PR documents those existing automation boundaries in English and Chinese and links the guide from the pull-request template.
Scope
Added docs/ci-integration.md.
Added the matching Chinese guide at docs/ci-integration.zh-CN.md.
Added one link from .github/PULL_REQUEST_TEMPLATE.md.
No workflow, renderer, schema, CLI, generated artifact, or archify.zip changes.
Non-goals
No new GitHub Actions workflow.
No change to receipt formats or exit codes.
No automatic PR commenting or artifact publishing.
Tests run
node bin/archify.mjs doctor — passed.
node bin/archify.mjs guide "Show an API request with a Redis cache miss" --json — passed.
Relative documentation targets were checked locally.
npm test — the repository suite reached two environment-specific failures on Windows: preview termination expects a clean SIGTERM exit, and the Cursor archive test requires the Unix unzip executable. The documentation-related checks passed.
Generated artifacts
None. This PR changes documentation only; archify.zip remains fresh.
Visual evidence
Not applicable.
Review follow-up
Addressed all requested items:
Replaced the relative PR-template link with the canonical repository/blob URL.
Corrected both GitHub Actions examples and both deliver snippets to use examples/agent-tool-call.workflow.json from working-directory: archify.
Removed the link to the separate unmerged troubleshooting PR and linked the existing delivery contract instead.
Narrowed package-freshness wording: docs outside archify/ do not require a zip rebuild; documentation inside the packaged archify/ tree, including references, examples, and SKILL.md, does.
Stated that scripts/build-zip.sh runs from the repository root.
Removed trailing blank lines from both new Markdown files.
Thanks for documenting the CI and pull-request workflow in both languages. I merged this head with the current main locally and the full suite passes 629/629. The overall receipt-handling guidance is useful, but I found several documentation paths that need correction before merge:
The link added to .github/PULL_REQUEST_TEMPLATE.md does not work in its intended surface. Once the template is copied into a PR body, ../docs/ci-integration.md resolves to https://github.com/tt-a1i/archify/docs/ci-integration.md, which returns 404. Please use a repository/blob URL that remains valid from a PR body.
The Chinese GitHub Actions example runs from working-directory: archify but validates ../examples/agent-tool-call.workflow.json. That file does not exist and the documented command exits 1 with input/read. The English Action example correctly uses examples/agent-tool-call.workflow.json.
Both English and Chinese deliver snippets also use ../examples/agent-tool-call.workflow.json while invoking node bin/archify.mjs, which implies the archify/ working directory. These commands reproduce the same ENOENT failure. Please use examples/... or explicitly establish a different working directory and adjust the CLI path consistently.
Both guides link to troubleshooting documents that are not present in this PR or on current main: docs/troubleshooting.md and docs/troubleshooting.zh-CN.md. Please remove/defer those links or resolve the dependency on the separate unmerged PR before merging this one.
The package-freshness wording should also be narrowed. Documentation inside the packaged archify/ tree, including references and examples, does require rebuilding archify.zip; only documentation changes outside the packaged tree are exempt. Please also state that scripts/build-zip.sh is run from the repository root.
Small cleanup: git diff --check reports a blank line at EOF in both new Markdown files. There are currently no GitHub check results on this head, so please attach refreshed command receipts after updating both language versions.
Addressed the maintainer review comments in the latest commit. The updated PR description contains the exact verification commands and results.
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
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.
Problem and value
Archify already has stable JSON receipts and repository CI jobs, but contributors need a reusable example for validating diagrams, uploading receipts, producing trusted artifacts, and checking package freshness.
This PR documents those existing automation boundaries in English and Chinese and links the guide from the pull-request template.
Scope
docs/ci-integration.md.docs/ci-integration.zh-CN.md..github/PULL_REQUEST_TEMPLATE.md.archify.zipchanges.Non-goals
Tests run
node bin/archify.mjs doctor— passed.node bin/archify.mjs guide "Show an API request with a Redis cache miss" --json— passed.node bin/archify.mjs validate sequence examples/cache-miss-request.sequence.json --quality showcase --json— passed: 9/9 checks, 0 errors, 0 warnings.npm test— the repository suite reached two environment-specific failures on Windows: preview termination expects a clean SIGTERM exit, and the Cursor archive test requires the Unixunzipexecutable. The documentation-related checks passed.Generated artifacts
None. This PR changes documentation only;
archify.zipremains fresh.Visual evidence
Not applicable.
Review follow-up
Addressed all requested items:
Fresh verification: