Skip to content

ci(release): publish the repository readme on npm - #1

Merged
Fenish merged 1 commit into
mainfrom
ci/npm-readme
Oct 11, 2026
Merged

Fenish merged 1 commit into
mainfrom
ci/npm-readme

Conversation

@Fenish

@Fenish Fenish commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

The npm page for skillpouch showed an old 10-line README ("Coming soon").

  • scripts/release.mjs stamp now copies the root README.md into npm/skillpouch, rewriting relative links: images to raw.githubusercontent.com/…/v<version>/…, files and folders to github.com/…/blob/v<version>/….
  • The separate npm/skillpouch/README.md is removed and ignored; it's generated at release.
  • Tests: the rewrite itself, and every link in the real README is absolute.

ci: doesn't release by itself; the npm page updates with the next fix/feat release.

The npm page showed a stale 'Coming soon' README. The release now writes README.md into the npm package with its relative links and images pointing at the release tag on GitHub, and a test checks that every link in it works from npm.
@Fenish
Fenish merged commit 289da7c into main Oct 11, 2026
5 checks passed
@Fenish
Fenish deleted the ci/npm-readme branch October 11, 2026 08:40
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