feat: build to bundle README.md in .kpar (not configurable)#239
Merged
consideRatio merged 1 commit intosensmetry:mainfrom Apr 1, 2026
Merged
feat: build to bundle README.md in .kpar (not configurable)#239consideRatio merged 1 commit intosensmetry:mainfrom
consideRatio merged 1 commit intosensmetry:mainfrom
Conversation
consideRatio
changed the title
consideRatio
force-pushed
the
pr/simple-readme
branch
2 times, most recently
from
f30f242 to
ed32baa
Compare
Collaborator
Author
|
Thank you @andrius-puksta-sensmetry for reviewing!! I've updated things based on your feedback and rebased this branch on main. |
consideRatio
commented
Mar 31, 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. 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
force-pushed
the
pr/simple-readme
branch
from
ed32baa to
cbbc416
Compare
andrius-puksta-sensmetry
approved these changes
Apr 1, 2026
Collaborator
andrius-puksta-sensmetry
left a comment
andrius-puksta-sensmetry
left a comment
There was a problem hiding this comment.
Adding a new method to ProjectRead that is only implemented by one type is not elegant, but without specializing KPAR building to take specific project types, this is the best we get...
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
2 participants
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.
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.