Skip to content

ci(release): publish with the English README on the npm page, 0.24.3 - #65

Merged
Surdeddd merged 4 commits into
mainfrom
fix/npm-readme-english
Nov 15, 2026
Merged

Surdeddd merged 4 commits into
mainfrom
fix/npm-readme-english

Conversation

@Surdeddd

Copy link
Copy Markdown
Owner

What this changes

The release workflow deletes README.ru.md from its checkout before it packs and publishes, so the npm page shows the English README. Released as 0.24.3. No code or documentation in the package changes, and README.ru.md stays in the repository.

Why

The npm page has been in Russian since 0.23.4, the release that added README.ru.md:

$ npm view @surdeddd/[email protected] readmeFilename   → README.ru.md
$ npm view @surdeddd/[email protected] readmeFilename   → README.ru.md
$ npm view @surdeddd/bottom-sheet readmeFilename          → README.ru.md   (0.24.2)

npm publish takes the readme from the package directory, not from the tarball. @npmcli/package-json globs {README,README.*} and keeps the first .md it finds; with README.md and README.ru.md side by side that is README.ru.md. The files list does not take part in that choice.

Checked with the module npm itself uses (@npmcli/package-json from npm 11.20.0, normalize with the readme step): with both files present it picks README.ru.md; with README.ru.md removed it picks README.md.

Verification

  • npx tsc --noEmit: clean (pre-commit hook)
  • npx vitest run: 100 files, 1040 passed, 2 skipped
  • npx playwright test: visual projects 21 of 21 after regenerating the hero baselines, which print the version (darwin here, linux from Visual baselines (linux))
  • npm run docs:check: 39 files OK
  • release.yml parses
  • The npm page itself: checked after the tag is published, with npm view @surdeddd/bottom-sheet readmeFilename

Checklist

  • No comments added to src/ or demo/
  • Behaviour change is covered by a test that fails without the fix: not testable in CI before publishing; the post-release check above is the test
  • Public API change is reflected in docs/ and CHANGELOG.md: no API change; CHANGELOG has the entry
  • Touched src/styles/bottom-sheet.css? No
  • Added a subpath export? No
  • Changed the demo's rendered layout? Only the version in the hero; both baseline sets are regenerated

npm takes the package page's readme from the package directory, not from
the tarball: @npmcli/package-json globs {README,README.*} and keeps the
first .md it sees, and with README.md and README.ru.md side by side it
picks README.ru.md, on macOS and on the runner alike. So every release
since 0.23.4, when the Russian README was added, put Russian on the npm
page (`npm view @surdeddd/[email protected] readmeFilename` gives
README.ru.md). The file is not in "files" either, so the workflow drops
it from the checkout before packing.
From the Visual baselines (linux) workflow run on this branch; only the
seven hero snapshots, which print the version.
@vercel

vercel Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
bottom-sheet-demo Ready Ready Preview Nov 15, 2026 12:28pm UTC

@github-actions

Copy link
Copy Markdown

Bundle size report (gzip, threshold 5%)

File Base PR Δ bytes Δ % Status
dist/index.js 35.57 KB 35.57 KB +0 0.00% ok
dist/react.js 46.16 KB 46.16 KB +0 0.00% ok
dist/preact.js 0.05 KB 0.05 KB +0 0.00% ok
dist/vue.js 40.14 KB 40.14 KB +0 0.00% ok
dist/svelte.js 39.59 KB 39.59 KB +0 0.00% ok
dist/solid.js 38.21 KB 38.21 KB +0 0.00% ok
dist/qwik.js 38.27 KB 38.27 KB +0 0.00% ok
dist/element.js 46.33 KB 46.33 KB +0 0.00% ok
dist/element.iife.global.js 33.04 KB 33.04 KB +0 0.00% ok
dist/overlay.js 11.19 KB 11.19 KB +0 0.00% ok
dist/styles.css 2.68 KB 2.68 KB +0 0.00% ok
dist/themes/ios.css 0.27 KB 0.27 KB +0 0.00% ok
dist/themes/material.css 0.27 KB 0.27 KB +0 0.00% ok
dist/themes/vercel.css 0.24 KB 0.24 KB +0 0.00% ok

All tracked entries are within the 5% budget.

@Surdeddd
Surdeddd merged commit 1652745 into main Nov 15, 2026
12 checks passed
@Surdeddd
Surdeddd deleted the fix/npm-readme-english branch November 15, 2026 12:45

This branch was successfully deployed

3 active deployments
Production — 16527459 Deployed Nov 15, 2026 by vercel[bot]
github-pages — 16527459 Deployed Nov 15, 2026 by Surdeddd via deploy #25
Preview — 16527459 Deployed Nov 15, 2026 by vercel[bot]
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