Skip to content

Commit 0e39c77

Browse files
authored
Merge pull request #4 from nextlevelbuilder/fix/npm-readme
fix(cli): include README in published npm package
2 parents 91d18e5 + ccb3965 commit 0e39c77

3 files changed

Lines changed: 7 additions & 1 deletion

File tree

.github/workflows/release.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ jobs:
5353
- name: Build CLI
5454
run: pnpm --filter f2u-cli build
5555

56+
- name: Copy root README into CLI package
57+
run: cp README.md packages/cli/README.md
58+
5659
- name: Publish to npm
5760
run: pnpm --filter f2u-cli publish --access public --no-git-checks
5861
env:

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
node_modules/
22
dist/
3+
# README in packages/cli is auto-copied from root at publish time
4+
packages/cli/README.md
35
.wrangler/
46
.dev.vars
57
*.log

packages/cli/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"scripts": {
1313
"dev": "tsx src/index.ts",
1414
"build": "tsup",
15-
"prepublishOnly": "pnpm build"
15+
"copy:readme": "node -e \"require('fs').copyFileSync('../../README.md','README.md')\"",
16+
"prepublishOnly": "pnpm copy:readme && pnpm build"
1617
},
1718
"publishConfig": {
1819
"access": "public"

0 commit comments

Comments
 (0)