Skip to content

feat: build to bundle README.md in .kpar (not configurable)#239

Open
consideRatio wants to merge 1 commit intosensmetry:mainfrom
consideRatio:pr/simple-readme
Open

feat: build to bundle README.md in .kpar (not configurable)#239
consideRatio wants to merge 1 commit intosensmetry:mainfrom
consideRatio:pr/simple-readme

Conversation

@consideRatio
Copy link
Collaborator

@consideRatio consideRatio commented Mar 19, 2026

If a README.md file exists at the project root, it is automatically included in the .kpar archive. This allows package indexes to display README content on package pages. If no README.md exists, the build proceeds normally.

The README.md inclusion, or file choice, isn't configurable in this PR. It just relies on detecting the hardcoded path. I tried it in #217 but I found that when configuration fields arrived, in combination with bindings and workspaces, the complexity exploded and I want to do more smaller PRs instead of a massive one.

By getting this to land first, we can get to verify the sysand client and index server interactions.

If a README.md file exists at the project root, it is automatically
included in the .kpar archive. This allows package indexes to display
README content on package pages. If no README.md exists, the build
proceeds normally.

Closes sensmetry#86

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Signed-off-by: Erik Sundell <erik.sundell+2025@sensmetry.com>
@consideRatio consideRatio changed the title feat: bundle README.md into .kpar archives during build feat: build to bundle README.md in .kpar (not configurable) Mar 19, 2026
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