Repository navigation
docs: add server + web package READMEs; skip CI on README-only changes - #11
Merged
Merged
Conversation
- packages/server/README.md — the @videonim/server package lists README.md in its 'files' but none existed, so the published package shipped without one. Documents CLI + library usage, exports, env vars, and the API. - packages/web/README.md — short readme for the (private) web app: dev/build/test commands and a pointer to the repo README. Root, x-url, and contracts READMEs were already accurate — no changes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add a trailing '!**/README.md' exclusion to the push + pull_request path filters. A change touching only README files is now skipped; a change that also touches real code (packages/**, db/**, manifests, the workflow) still triggers CI.
notBscalE
changed the title
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.
README housekeeping ahead of going public.
Package READMEs
packages/server/README.md(new) — the package'sfilesalready referencedREADME.mdbut it didn't exist, so the published@videonim/servershipped with no README. Adds CLI + library usage, exports, env-var table, and the API summary.packages/web/README.md(new) — short readme for the private web app.@videonim/x-url,@videonim/contractsREADMEs reviewed — already accurate, unchanged.CI: skip README-only changes
!**/README.mdexclusion to thepush+pull_requestpath filters. A change touching only README files is now skipped; a change that also touches real code (packages/**,db/**, manifests, the workflow) still triggers CI.Note: this PR edits
.github/workflows/ci.yml(a trigger path), so CI does run on it; the README-skip behavior applies to future changes.🤖 Generated with Claude Code