docs(readme): rewrite around what an artifact is and how to boot it - #25
Open
TheGreatAxios wants to merge 2 commits into
Open
TheGreatAxios wants to merge 2 commits into
TheGreatAxios wants to merge 2 commits into
Conversation
TheGreatAxios
commented
Sep 25, 2026
TheGreatAxios
left a comment
Contributor
Author
There was a problem hiding this comment.
Reviewed the whole branch against the code. The boot snippet matches createArtifactDb ({ db, close }) and runArtifactMigrations(db, options?). The option rows and their defaults match src/mount.ts and src/workflow-mount.ts, and the /api/workflow-artifacts path matches WORKFLOW_ARTIFACTS_BASE_PATH. Apart from the renamed Migration runner heading and the dropped options table, which the README tables now replace, the internals text moved into CONTRIBUTING.md unchanged. No stale ARCHITECTURE.md references remain. Each commit's message matches its diff. No blocking findings.
Open with a plain definition, collapse the install block to npm, and
show the migration boot with createArtifactDb's { db, close } result
destructured, since passing the whole object did not typecheck. Drop
the Runtime support section (no bun export condition exists) and the
How it works section that restated the mount sections. Spell out every
mount option in the reference tables instead of deferring to
ARCHITECTURE.md, and say plainly that the host binds the agent's hub
credential. Contributor setup moves to CONTRIBUTING.md.
The internals write-up moves from ARCHITECTURE.md into CONTRIBUTING.md, so the repo root carries only README and CONTRIBUTING like other Corbits packages. SECURITY.md moves to .github/, where GitHub still surfaces it as the security policy.
TheGreatAxios
force-pushed
the
cl-9092-artifacts-fix-readme-passing-createartifactdb-result-to
branch
from
September 26, 2026 01:29
cc8ba8f to
75e8ad1
Compare
TheGreatAxios
added this pull request to stack #32
September 26, 2026 01:57
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
npm addline, and shows the boot sequence withcreateArtifactDb's{ db, close }destructured andclose()on shutdown.bunexport condition) and the "How it works" section that restated the mount sections are gone.mountArtifacts/mountWorkflowArtifactsoption, includingonArtifactCreated,decorate,uploadPolicy,maxBinaryBytesandmaxContentChars, has a row in the README reference tables with its default.hubcredential to its hub token and that the run-scoped routes live at/api/workflow-artifacts..github/, where GitHub still surfaces it as the security policy.HUB_CREDENTIAL_HANDLEinsrc/sidecar-bundle.ts.main.Verification
src/schema.ts.bun run typecheckis clean.src/db.ts,src/migrations.ts,src/mount.tsandsrc/workflow-mount.ts.Closes CL-9092
Closes CL-9096
Closes CL-9097
Closes CL-9101
Closes CL-9108
Closes CL-9111
Closes CL-9113
Closes CL-9129