Skip to content

okf: add optional .okfignore convention (SPEC 3.2)#190

Open
manumishra12 wants to merge 1 commit into
GoogleCloudPlatform:mainfrom
manumishra12:spec-okfignore-convention
Open

okf: add optional .okfignore convention (SPEC 3.2)#190
manumishra12 wants to merge 1 commit into
GoogleCloudPlatform:mainfrom
manumishra12:spec-okfignore-convention

Conversation

@manumishra12

Copy link
Copy Markdown

What

Adds an optional .okfignore convention as a new subsection (SPEC section 3.2) so producers can mark files or directories that consumers and enrichment agents SHOULD skip when walking a bundle — drafts, scratch notes, large binaries, and similar non-knowledge files.

Semantics

  • MAY appear at the bundle root, and in any subdirectory (applying to its own subtree).
  • gitignore-style path patterns, one per line; blank lines and # comments ignored.
  • Consumers and agents SHOULD skip matching files and directories.
  • Never affects conformance: matching files are skipped, not forbidden, so a bundle is equally valid without one, and a consumer that does not implement ignore files MAY read the whole tree.

Spec-only, additive, and backward-compatible (SPEC section 11 minor-version rules). Reference-tooling support can follow.

Addresses #77.

Adds an optional ignore-file convention so producers can mark files or
directories that consumers and enrichment agents SHOULD skip when walking a
bundle (drafts, scratch notes, large binaries). Uses gitignore-style patterns
and never affects conformance: matching files are skipped, not forbidden.

Additive and backward-compatible (per SPEC 11). Addresses GoogleCloudPlatform#77.
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