Skip to content

docs: npm package release guide (package.json + package-lock.json via --exec) - #35

Merged
loki-inu merged 1 commit into
mainfrom
docs/npm-package-guide
Nov 3, 2026
Merged

loki-inu merged 1 commit into
mainfrom
docs/npm-package-guide

Conversation

@loki-inu

@loki-inu loki-inu commented Nov 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • New docs page npm-package.html: cut a release with release.sh --bump-file package.json --exec "npm install --package-lock-only --ignore-scripts --silent", then a tag-push workflow that checks the tag, runs npm ci / npm test, publishes with npm trusted publishing (id-token: write), and creates a GitHub Release with loki-inu/relnote@v0.3.7 notes.
  • tests/test_npm_package_docs.py rebuilds the example with real npm: asserts lockfile sync with --exec, stale lock without it, CHANGELOG/notes match, tag-check step. Suite 130. Workflow actionlint-clean.
  • Linked from index, README, llms.txt, sitemap, python-package / rust-crate / standard-version pages. Pins stay on v0.3.7 (docs-only; no release).

Test plan

  • python3 -m unittest discover -s tests (130 OK locally)
  • actionlint on the page's release.yml block
  • CI green on this PR

… --exec)

Mirror the Python/Rust guides: bump package.json with release.sh
--bump-file, sync package-lock.json with --exec "npm install
--package-lock-only --ignore-scripts --silent", tag-push workflow with
tag check, npm ci/test, trusted publishing, and gh release create.
tests/test_npm_package_docs.py runs it with real npm.
@loki-inu
loki-inu merged commit 82011be into main Nov 3, 2026
4 checks passed
@loki-inu
loki-inu deleted the docs/npm-package-guide branch November 3, 2026 09:24
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