@@ -5,7 +5,7 @@ General notes about collaborating/doing maintenance work on Neovide.
5
5
## How to keep your sanity
6
6
7
7
- Don't think you need to solve, participate in or even notice everything
8
- happening.
8
+ happening.
9
9
10
10
Work on such a project where most things are already done and the things left
11
11
aren't that fun anymore can be very gruesome, even if that might not be
@@ -28,7 +28,7 @@ General notes about collaborating/doing maintenance work on Neovide.
28
28
it could be worded better/could be found better.
29
29
30
30
- Ask for more information if you require so. Some investigation can be done by
31
- the user.
31
+ the user.
32
32
33
33
If some case requires some special environmental information which isn't given
34
34
in the original report, ask for it. Or if you aren't sure what you're looking
@@ -52,24 +52,23 @@ see fit (and then update here with your findings).
52
52
53
53
### Preparing
54
54
55
- 1 . Head over to [ the releases page] [ releases-page ] and hit the `Draft a new
56
- release` button.
55
+ 1 . Head over to [ the releases page] [ releases-page ] and hit the ` Draft a new release ` button.
57
56
2 . Keep the resulting page somewhere safe open, you'll need to work with it the
58
- next half an hour and GitHub doesn't automatically save its contents.
57
+ next half an hour and GitHub doesn't automatically save its contents.
59
58
3 . Create a new tag with an appropriate version number.
60
59
61
- We're not fully following [ SemVer] [ semver ] here, but as of 0.10.1 larger
62
- changes should be an increase in the MINOR part, while fixups should be an
63
- increase in the PATCH part.
60
+ We're not fully following [ SemVer] [ semver ] here, but as of 0.10.1 larger
61
+ changes should be an increase in the MINOR part, while fixups should be an
62
+ increase in the PATCH part.
64
63
65
64
1 . Hit the ` Generate release notes ` button.
66
65
2 . Reformat to be similar to previous releases
67
66
68
- - Rename the ` What's Changed ` section to ` Changes `
69
- - Rewrite each line in the ` Changes ` section to reflect what this change means
70
- for the end user, linking to the relevant PR/commit
71
- - Group all bug fix PRs/commits under a point named ` Bug fixes `
72
- - Have each line reflect what platform it applies to if not irrelevant
67
+ - Rename the ` What's Changed ` section to ` Changes `
68
+ - Rewrite each line in the ` Changes ` section to reflect what this change means
69
+ for the end user, linking to the relevant PR/commit
70
+ - Group all bug fix PRs/commits under a point named ` Bug fixes `
71
+ - Have each line reflect what platform it applies to if not irrelevant
73
72
74
73
3 . Hit the ` Save draft ` button
75
74
@@ -83,11 +82,11 @@ change is included.
83
82
### Actually releasing
84
83
85
84
1 . Announce a short period of time where last changes to be done or fixup work
86
- can flow in (can be anything you imagine, though 24 hours to one week might
87
- be enough depending on the blocker)
85
+ can flow in (can be anything you imagine, though 24 hours to one week might
86
+ be enough depending on the blocker)
88
87
2 . Wait for that period to pass
89
88
3 . Have a last look over the draft to make sure every new contributor and change has
90
- been mentioned
89
+ been mentioned
91
90
92
91
Now here's where the order becomes important:
93
92
@@ -96,16 +95,15 @@ Now here's where the order becomes important:
96
95
3 . Create a commit named ` Run cargo update ` or similar
97
96
4 . Bump the version to match the tag name everywhere
98
97
99
- - ` Cargo.toml ` (do note it contains the version _ twice_ , one time in the
100
- top, one time at the bottom in the bundling section)
101
- - ` extra/osx/Neovide.app/Contents/Resources/Info.plist `
102
- - ` website/docs/*.md ` and update ` Unreleased yet ` to ` Available since $tag `
103
- (where ` $tag ` is the tag name)
98
+ - ` Cargo.toml ` (do note it contains the version _ twice_ , one time in the
99
+ top, one time at the bottom in the bundling section)
100
+ - ` extra/osx/Neovide.app/Contents/Resources/Info.plist `
101
+ - ` website/docs/*.md ` and update ` Unreleased yet ` to ` Available since $tag `
102
+ (where ` $tag ` is the tag name)
104
103
105
- 5 . Run ` cargo build ` and make sure it succeeds, ** remember to `git add
106
- Cargo.lock` to make sure releases stay reproducible
107
- ([ #1628 ] ( https://github.com/neovide/neovide/issues/1628 ) ,
108
- [ #1482 ] ( https://github.com/neovide/neovide/issues/1482 ) )**
104
+ 5 . Run ` cargo build ` and make sure it succeeds, ** remember to ` git add Cargo.lock ` to make sure releases stay reproducible
105
+ ([ #1628 ] ( https://github.com/neovide/neovide/issues/1628 ) ,
106
+ [ #1482 ] ( https://github.com/neovide/neovide/issues/1482 ) )**
109
107
6 . Create a commit called ` Bump version to $tag `
110
108
7 . Push and wait for CI to complete (will take around 25 minutes)
111
109
8 . Run ` cargo build --frozen `
@@ -116,13 +114,13 @@ anything.
116
114
1 . From the ` Bump version to $tag ` commit, download all the artifacts
117
115
2 . Unzip
118
116
119
- - ` neovide.AppImage.zip `
120
- - ` neovide.AppImage.zsync.zip `
121
- - ` neovide.msi.zip `
122
- - ` neovide-linux-x86_64.tar.gz.zip `
117
+ - ` neovide.AppImage.zip `
118
+ - ` neovide.AppImage.zsync.zip `
119
+ - ` neovide.msi.zip `
120
+ - ` neovide-linux-x86_64.tar.gz.zip `
123
121
124
122
3 . Head to the release draft, edit it and upload the produced artifacts (using
125
- the unzipped versions if listed above)
123
+ the unzipped versions if listed above)
126
124
4 . Hit ` Publish release `
127
125
5 . profit
128
126
0 commit comments