@take-out/docs 0.1.4 → 0.1.9
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.
- package/package.json +1 -1
- package/release.md +50 -0
- /package/{sync-prompt.md → sync-repo.md} +0 -0
package/package.json
CHANGED
package/release.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: takeout-release
|
|
3
|
+
description: Release and publish workflow for Takeout packages. npm publish, version bump, patch release, minor release, major release, canary release, publishing packages, tagging, git tag.
|
|
4
|
+
dev: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Release
|
|
8
|
+
|
|
9
|
+
all takeout packages are versioned and published together using the release script.
|
|
10
|
+
|
|
11
|
+
## usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
bun ./packages/scripts/src/release.ts --patch # patch bump (0.1.4 -> 0.1.5)
|
|
15
|
+
bun ./packages/scripts/src/release.ts --minor # minor bump (0.1.4 -> 0.2.0)
|
|
16
|
+
bun ./packages/scripts/src/release.ts --major # major bump (0.1.4 -> 1.0.0)
|
|
17
|
+
bun ./packages/scripts/src/release.ts --canary # canary with timestamp
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## what it does
|
|
21
|
+
|
|
22
|
+
1. syncs on-zero from github (if ~/github/on-zero exists)
|
|
23
|
+
2. ensures on main branch, pulls latest
|
|
24
|
+
3. runs `bun install`, `bun clean`, `bun run build`
|
|
25
|
+
4. runs `bun lint` and `bun check:all`
|
|
26
|
+
5. bumps version in ALL workspace package.json files
|
|
27
|
+
6. converts `workspace:*` deps to real versions for publishing
|
|
28
|
+
7. packs each package with `bun pm pack`
|
|
29
|
+
8. publishes each .tgz with `npm publish`
|
|
30
|
+
9. restores `workspace:*` protocols after publishing
|
|
31
|
+
10. runs `bun install` to update lockfile
|
|
32
|
+
11. commits, tags (v0.1.5), pushes commit + tag
|
|
33
|
+
12. syncs on-zero out to github
|
|
34
|
+
|
|
35
|
+
## important flags
|
|
36
|
+
|
|
37
|
+
- `--dirty` - skip git clean check (allow uncommitted changes)
|
|
38
|
+
- `--dry-run` - do everything except actually publish/commit/push
|
|
39
|
+
- `--skip-test` - skip lint and check steps
|
|
40
|
+
- `--skip-build` - skip clean and build steps
|
|
41
|
+
- `--rerun` / `--republish` - re-publish current version (for failed publishes)
|
|
42
|
+
- `--finish` - just do the git commit/tag/push step (if publish succeeded but push failed)
|
|
43
|
+
- `--skip-finish` - publish but don't commit/tag/push
|
|
44
|
+
|
|
45
|
+
## rules
|
|
46
|
+
|
|
47
|
+
- NEVER manually `npm version` + `npm publish` a single package - all packages release together
|
|
48
|
+
- NEVER manually edit version numbers - the release script handles all versioning
|
|
49
|
+
- if push fails after publish, use `--finish` to retry the git steps
|
|
50
|
+
- the script reads current version from `packages/helpers/package.json`
|
|
File without changes
|