Commit 1a849eb
authored
chore: update docs for git tag updates (#536)
### TL;DR
Updated version tagging format docs to use proper three-part semver versions to ensure Electron auto-updates work correctly.
### What changed?
- Changed all base tag examples from two-part format (`vX.Y`) to three-part format (`vX.Y.0`)
- Updated all references and examples throughout the document to use the three-part semver format
- Added an important note explaining that Electron auto-updater requires valid semver for version comparison
- Updated the git tag search command to look for three-part version tags
### How to test?
1. Verify the updated documentation accurately reflects the new tagging format
2. Test the updated git commands to ensure they correctly identify the latest version tag
3. Confirm that creating a new tag with the format `vX.Y.0` works as expected for version calculation
### Why make this change?
The Electron auto-updater uses update.electronjs.org, which requires valid semver for version comparison. Two-part versions were breaking the auto-update functionality. This change ensures that all version tags follow proper semver format, maintaining compatibility with the Electron update system.1 parent fc9dc3c commit 1a849eb
1 file changed
Lines changed: 14 additions & 12 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
12 | 14 | | |
13 | 15 | | |
14 | | - | |
15 | | - | |
| 16 | + | |
| 17 | + | |
16 | 18 | | |
17 | 19 | | |
18 | 20 | | |
19 | 21 | | |
20 | 22 | | |
21 | 23 | | |
22 | 24 | | |
23 | | - | |
| 25 | + | |
24 | 26 | | |
25 | 27 | | |
26 | 28 | | |
| |||
31 | 33 | | |
32 | 34 | | |
33 | 35 | | |
34 | | - | |
35 | | - | |
| 36 | + | |
| 37 | + | |
36 | 38 | | |
37 | 39 | | |
38 | 40 | | |
| |||
42 | 44 | | |
43 | 45 | | |
44 | 46 | | |
45 | | - | |
46 | | - | |
| 47 | + | |
| 48 | + | |
47 | 49 | | |
48 | 50 | | |
49 | 51 | | |
| |||
52 | 54 | | |
53 | 55 | | |
54 | 56 | | |
55 | | - | |
| 57 | + | |
56 | 58 | | |
57 | 59 | | |
58 | | - | |
| 60 | + | |
59 | 61 | | |
60 | 62 | | |
61 | 63 | | |
62 | 64 | | |
63 | | - | |
| 65 | + | |
64 | 66 | | |
65 | 67 | | |
66 | | - | |
| 68 | + | |
0 commit comments