Spaces:
Running
Running
chore: remove unused file
Browse files- CHANGESET_GUIDE.md +0 -87
CHANGESET_GUIDE.md
DELETED
@@ -1,87 +0,0 @@
|
|
1 |
-
# π Changesets Workflow Guide
|
2 |
-
|
3 |
-
## Setup (One Time Only)
|
4 |
-
|
5 |
-
### 1. Add NPM Token to GitHub
|
6 |
-
|
7 |
-
1. Go to [npmjs.com](https://npmjs.com) β Account β Access Tokens
|
8 |
-
2. Create **Automation** token with **Publish** permission
|
9 |
-
3. Copy the token
|
10 |
-
4. Go to GitHub β Settings β Secrets β Actions
|
11 |
-
5. Add secret: `NPM_TOKEN` = your token
|
12 |
-
|
13 |
-
### 2. Verify Access
|
14 |
-
|
15 |
-
Make sure you have publish access to `@lerobot/web` on npm.
|
16 |
-
|
17 |
-
## Daily Workflow
|
18 |
-
|
19 |
-
### 1. Make Changes
|
20 |
-
|
21 |
-
```bash
|
22 |
-
# Edit code in packages/web/
|
23 |
-
# Test your changes
|
24 |
-
pnpm --filter "@lerobot/web" run build
|
25 |
-
```
|
26 |
-
|
27 |
-
### 2. Create Changeset
|
28 |
-
|
29 |
-
```bash
|
30 |
-
pnpm changeset
|
31 |
-
```
|
32 |
-
|
33 |
-
- Select package: `@lerobot/web`
|
34 |
-
- Choose version bump: `patch` | `minor` | `major`
|
35 |
-
- Write summary: "Add new feature X" or "Fix bug Y"
|
36 |
-
|
37 |
-
### 3. Commit & Push
|
38 |
-
|
39 |
-
```bash
|
40 |
-
git add .
|
41 |
-
git commit -m "feat: add new functionality"
|
42 |
-
git push origin main
|
43 |
-
```
|
44 |
-
|
45 |
-
### 4. Magic Happens! β¨
|
46 |
-
|
47 |
-
- GitHub Actions creates **Release PR** with changelog
|
48 |
-
- **Merge the PR** β Automatic publish to npm
|
49 |
-
- **New version is live!**
|
50 |
-
|
51 |
-
## Commands Available
|
52 |
-
|
53 |
-
```bash
|
54 |
-
# Create a changeset (describe your changes)
|
55 |
-
pnpm changeset
|
56 |
-
|
57 |
-
# Preview what will be released
|
58 |
-
pnpm changeset:version
|
59 |
-
|
60 |
-
# Manual publish (emergency only)
|
61 |
-
pnpm changeset:publish
|
62 |
-
```
|
63 |
-
|
64 |
-
## Version Types
|
65 |
-
|
66 |
-
- **patch** (0.1.0 β 0.1.1) - Bug fixes
|
67 |
-
- **minor** (0.1.0 β 0.2.0) - New features
|
68 |
-
- **major** (0.1.0 β 1.0.0) - Breaking changes
|
69 |
-
|
70 |
-
## Example Flow
|
71 |
-
|
72 |
-
```bash
|
73 |
-
# 1. Edit packages/web/src/calibrate.ts
|
74 |
-
# 2. Create changeset
|
75 |
-
pnpm changeset
|
76 |
-
# β Select @lerobot/web
|
77 |
-
# β Choose "minor"
|
78 |
-
# β Summary: "Add new calibration mode"
|
79 |
-
|
80 |
-
# 3. Commit
|
81 |
-
git add .
|
82 |
-
git commit -m "feat: add new calibration mode"
|
83 |
-
git push
|
84 |
-
|
85 |
-
# 4. GitHub will create Release PR automatically
|
86 |
-
# 5. Merge PR β @lerobot/[email protected] published! π
|
87 |
-
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|