@jibone/todotxt-core 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -0
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -199,3 +199,25 @@ bun test
199
199
  bunx tsc
200
200
  bun run build
201
201
  ```
202
+
203
+ ## Releasing
204
+
205
+ Releases are published manually from `master`:
206
+
207
+ ```sh
208
+ bun run release patch # bump and publish
209
+ bun run release minor # or major
210
+ ```
211
+
212
+ Use `bun run release current` only when `package.json` already contains a version
213
+ that has not been published yet (for example, the very first release).
214
+
215
+ The release script requires a clean, in-sync `master` plus authenticated `npm`
216
+ and `gh` CLIs. It runs the test, build, and package validation steps, then bumps
217
+ the version, publishes to npm, pushes the release commit and tag, and creates a
218
+ GitHub Release with generated notes. Add `--dry-run` to see the plan without
219
+ changing anything:
220
+
221
+ ```sh
222
+ bun run release patch --dry-run
223
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jibone/todotxt-core",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Parse and query todo.txt files with runtime-agnostic file hooks.",
5
5
  "license": "MIT",
6
6
  "author": "J Shamsul Bahri",
@@ -45,6 +45,7 @@
45
45
  "build": "tsdown",
46
46
  "typecheck": "tsc --noEmit",
47
47
  "test": "bun test",
48
+ "release": "bun scripts/release.ts",
48
49
  "prepack": "bun run build",
49
50
  "prepublishOnly": "bun test && bunx tsc"
50
51
  },