Skip to content

Commit b8ae5af

Browse files
Merge pull request #4519 from micheleCTDE/update-release-file
Improvements to the release-process.rst file
2 parents 059b751 + 76594f3 commit b8ae5af

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

release-process.rst

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
*This document was last updated on 2025/05/17, for Uncrustify 0.81.0.*
88

9-
This document uses "0.1.2" throughout as an example version number.
9+
This document uses "0.x.0" throughout as an example version number.
1010
Whenever you see this, you should substitute the version number
1111
of the new release being prepared.
1212

@@ -219,26 +219,21 @@ Finally, delete the release branch upstream and locally
219219
Create Binaries
220220
===============
221221

222-
Create a tarball:
222+
Create a tarball and zip archive of the sources:
223223

224224
.. code::
225225
226226
$ cd /path/to/uncrustify
227-
$ git archive -o ../uncrustify-0.1.2.tar.gz --prefix=uncrustify-uncrustify-0.1.2/ uncrustify-0.1.2
228-
229-
Grab a copy of the sources from GitHub:
230-
231-
.. code::
232-
227+
$ git archive -o ../uncrustify-0.x.0.tar.gz --prefix=uncrustify-uncrustify-0.x.0/ uncrustify-0.x.0
233228
$ cd /path/to/uncrustify/..
234-
$ wget https://github.com/uncrustify/uncrustify/archive/uncrustify-0.1.2.zip
235-
$ unzip -e uncrustify-0.1.2.zip
229+
$ tar xzf ./uncrustify-0.x.0.tar.gz
230+
$ zip -r uncrustify-0.x.0.zip uncrustify-uncrustify-0.x.0
236231
237232
Build the Linux binaries:
238233

239234
.. code::
240235
241-
$ cd /path/to/uncrustify-uncrustify-0.1.2
236+
$ cd /path/to/uncrustify-uncrustify-0.x.0
242237
$ mkdir build
243238
$ cd build
244239
$ cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ..
@@ -250,7 +245,7 @@ Next, build the 32 and 64 bit Windows binaries:
250245

251246
.. code::
252247
253-
$ cd /path/to/uncrustify-uncrustify-0.1.2
248+
$ cd /path/to/uncrustify-uncrustify-0.x.0
254249
$ mkdir buildwin-32
255250
$ cd buildwin-32
256251
$ cmake -G Ninja \
@@ -263,7 +258,7 @@ Next, build the 32 and 64 bit Windows binaries:
263258
264259
.. code::
265260
266-
$ cd /path/to/uncrustify-uncrustify-0.1.2
261+
$ cd /path/to/uncrustify-uncrustify-0.x.0
267262
$ mkdir buildwin-64
268263
$ cd buildwin-64
269264
$ cmake -G Ninja \
@@ -284,30 +279,35 @@ Create a release on github
284279
- Add the release version under "Release title" as "Uncrustify 0.xx.y"
285280
- Upload the Windows binaries and the source code zip/tarball files in the section
286281
"Attach binaries by dropping them here or selecting them": these will show up as
287-
"Assets" under the release text. Executables for Windows 32 and 64 and source
288-
code in tar.gz and zip format need to be uploaded.
282+
"Assets" under the release text. The following files need to be added:
283+
- buildwin-32/uncrustify-0.x.0_f-win32.zip
284+
- buildwin-64/uncrustify-0.x.0_f-win64.zip
285+
- uncrustify-0.x.0.tar.gz
286+
- uncrustify-0.x.0.zip
289287
- Add release text in describing section. It is recommended to copy the text
290288
from previous releases and update the related files. Make sure to use bold text
291-
to highlight the various sections (use '### ' at the beginning of the line)
289+
to highlight the various sections (use '### ' at the beginning of the line).
290+
You need to drag the files into the text section to get a link to the actual
291+
files there. The same files mentioned above need to be added.
292292
- Publish the release by clicking on the "Publish release" button.
293293

294294
Upload to SourceForge
295295
=====================
296296

297297
- Login as admin under https://sourceforge.net/projects/uncrustify/
298298
- Change to https://sourceforge.net/projects/uncrustify/files/
299-
- "Add Folder"; the name should be e.g. "uncrustify-0.1.2"
299+
- "Add Folder"; the name should be e.g. "uncrustify-0.x.0"
300300
- Navigate to the new folder
301-
(e.g. https://sourceforge.net/projects/uncrustify/files/uncrustify-0.1.2/)
301+
(e.g. https://sourceforge.net/projects/uncrustify/files/uncrustify-0.x.0/)
302302
- Click "Add File" and upload the following files
303303
(adjusting for the actual version number):
304304
Click "Done" when all files have been uploaded.
305305

306306
* README.md
307-
* uncrustify-0.1.2.tar.gz
308-
* uncrustify-0.1.2.zip
309-
* buildwin-32/uncrustify-0.1.2_f-win32.zip
310-
* buildwin-64/uncrustify-0.1.2_f-win64.zip
307+
* uncrustify-0.x.0.tar.gz
308+
* uncrustify-0.x.0.zip
309+
* buildwin-32/uncrustify-0.x.0_f-win32.zip
310+
* buildwin-64/uncrustify-0.x.0_f-win64.zip
311311

312312
- Upload the documentation using the following commands:
313313

0 commit comments

Comments
 (0)