[ehennestad]

On R2026b the package readme is the file named by Readme, and File Exchange shows it as the submission text. A project README copied into the package through RootFilesToPackage is written for GitHub: its badges and relative links and image paths do not resolve on File Exchange.

Changes

• packageToolbox rewrites the staged copy of the file named by Readme after the version is known, with the new matbox.toolbox.internal.prepareReadme. A readme committed in the source folder is not changed. stageRootFilesForPackaging now returns the paths of the copies it staged, which is how packageToolbox tells the two apart.
• Badge lines: a line made only of Markdown images, linked or not, is removed when it lies in the leading block, before the first line of prose. Blank lines, headings and lines of HTML tags do not end the leading block. Image lines further down, such as figures, and HTML <img> lines, such as logos, are kept.
• Links: relative destinations of Markdown links and images, reference definitions and the HTML attributes href, src and srcset become absolute at the tag v<major>.<minor>.<patch> of the packaged version. A file becomes <repository>/blob/<tag>/<path>, a folder <repository>/tree/<tag>/<path>, and an image https://raw.githubusercontent.com/<owner>/<repo>/<tag>/<path> (<repository>/raw/<tag>/<path> off github.com). A leading ./ or / is dropped and a query or fragment is kept. Destinations with a scheme, starting with #, // or ../, and everything inside fenced code blocks are left as they are.
• matbox.toolbox.internal.getRepositoryUrl takes the repository from GITHUB_SERVER_URL and GITHUB_REPOSITORY on GitHub Actions, else from the origin remote, with SSH addresses and credentials converted to https://<host>/<owner>/<repo>. Without either, links stay relative and MatBox:Package:RepositoryUrlNotFound is issued.
• prepareReadmeFile reads and writes the readme as UTF-8.
• PrepareReadmeTest covers the transform and the repository URL. In TasksTest, the packaged readme of the Readme test is now compared with the processed text, and a new test checks that a committed readme is packaged unchanged.
• The README and docs/ci.md describe the processing.

Notes

On EBRAINS-MATLAB the processing removes the seven badge lines and turns the four relative links into blob and tree URLs. On openMINDS_MATLAB the logo block before the title is kept, with its /img/... paths made absolute.

🤖 Generated with Claude Code

[github-actions]

Test Results

133 tests   132 ✅  43s ⏱️
  8 suites    1 💤
  1 files      0 ❌

Results for commit 9b49818.

♻️ This comment has been updated with latest results.