Commit c8255f7
committed
refactor(release): use VERSION file as source of truth instead of automatic bumping
Changed release workflow from automated version bumping to manual VERSION control.
**Changes to prepare-release.sh:**
- Remove version bump type argument (patch/minor/major)
- Read VERSION file as-is instead of calculating new version
- Add semver validation for VERSION format
- Sync VERSION to package.json instead of bumping both
- Updated documentation to explain manual workflow
- Simplified: no longer writes to VERSION file, just reads it
**Changes to npm-release.yaml:**
- Remove workflow_dispatch inputs (version bump type selector)
- Update documentation to explain manual VERSION bumping
- Remove ${{ github.event.inputs.version }} parameter
**Developer workflow (new):**
1. Manually bump VERSION file (e.g., 0.4.0 → 0.4.1)
2. Update CHANGELOG-mceachen.md with changes
3. Commit: git commit -am "release: prepare v0.4.1"
4. Trigger npm-release.yaml workflow
5. Workflow syncs VERSION to package.json and publishes
**Rationale:**
- Single source of truth: "The version is whatever VERSION says"
- Prepare releases: Can update CHANGELOG for new version before triggering workflow
- Transparent: Version bumps are explicit, visible git commits
- Standard practice: Similar to Go modules, Rust crates, Python tools
This is more intuitive for future maintainers than having the version
magically calculated during workflow execution.1 parent 91cea55 commit c8255f7
2 files changed
Lines changed: 28 additions & 28 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
41 | | - | |
42 | | - | |
43 | | - | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
44 | 45 | | |
45 | 46 | | |
46 | 47 | | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
47 | 53 | | |
48 | 54 | | |
49 | 55 | | |
50 | | - | |
51 | | - | |
52 | | - | |
53 | | - | |
54 | | - | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | | - | |
59 | | - | |
60 | 56 | | |
61 | 57 | | |
62 | 58 | | |
| |||
86 | 82 | | |
87 | 83 | | |
88 | 84 | | |
89 | | - | |
| 85 | + | |
90 | 86 | | |
91 | 87 | | |
92 | 88 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
68 | | - | |
| 68 | + | |
69 | 69 | | |
70 | 70 | | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
| 71 | + | |
75 | 72 | | |
76 | 73 | | |
77 | | - | |
78 | | - | |
| 74 | + | |
| 75 | + | |
79 | 76 | | |
80 | 77 | | |
81 | | - | |
82 | | - | |
| 78 | + | |
| 79 | + | |
83 | 80 | | |
84 | 81 | | |
85 | 82 | | |
86 | 83 | | |
87 | | - | |
| 84 | + | |
88 | 85 | | |
89 | | - | |
| 86 | + | |
90 | 87 | | |
91 | 88 | | |
92 | 89 | | |
93 | 90 | | |
94 | 91 | | |
95 | 92 | | |
96 | 93 | | |
97 | | - | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
98 | 102 | | |
99 | 103 | | |
100 | 104 | | |
101 | 105 | | |
102 | 106 | | |
103 | | - | |
| 107 | + | |
104 | 108 | | |
105 | 109 | | |
106 | 110 | | |
107 | | - | |
| 111 | + | |
0 commit comments