Skip to content

Commit 4d446f7

Browse files
committed
fix(docs): format first-time setup instructions in npm release workflow
1 parent 9c446c8 commit 4d446f7

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

.github/workflows/npm-release.yaml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,14 @@ name: "npm Release"
1818
# FIRST-TIME SETUP (required before this workflow will work):
1919
#
2020
# 1. Build and publish the package locally to create it on npm:
21-
# ./scripts/vendor.sh make loadable mkdir -p dist/$(node -p "process.platform
22-
# + '-' + process.arch") cp dist/vec0.* dist/$(node -p "process.platform +
23-
# '-' + process.arch")/ npm login npm publish --access public
21+
# ```sh
22+
# ./scripts/vendor.sh
23+
# make loadable
24+
# mkdir -p dist/$(node -p "process.platform + '-' + process.arch")
25+
# cp dist/vec0.* dist/$(node -p "process.platform + '-' + process.arch")/
26+
# npm login
27+
# npm publish --access public --tag alpha # use --tag for prerelease versions
28+
# ```
2429
#
2530
# 2. Configure OIDC trusted publishing on npmjs.com:
2631
# - Go to https://www.npmjs.com/package/@USER/sqlite-vec/access

0 commit comments

Comments
 (0)