Skip to content

Improvements to the release-process.rst file #4519

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 18, 2025
Merged

Improvements to the release-process.rst file #4519

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions release-process.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

*This document was last updated on 2025/05/17, for Uncrustify 0.81.0.*

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

Expand Down Expand Up @@ -219,26 +219,21 @@ Finally, delete the release branch upstream and locally
Create Binaries
===============

Create a tarball:
Create a tarball and zip archive of the sources:

.. code::

$ cd /path/to/uncrustify
$ git archive -o ../uncrustify-0.1.2.tar.gz --prefix=uncrustify-uncrustify-0.1.2/ uncrustify-0.1.2

Grab a copy of the sources from GitHub:

.. code::

$ git archive -o ../uncrustify-0.x.0.tar.gz --prefix=uncrustify-uncrustify-0.x.0/ uncrustify-0.x.0
$ cd /path/to/uncrustify/..
$ wget https://github.com/uncrustify/uncrustify/archive/uncrustify-0.1.2.zip
$ unzip -e uncrustify-0.1.2.zip
$ tar xzf ./uncrustify-0.x.0.tar.gz
$ zip -r uncrustify-0.x.0.zip uncrustify-uncrustify-0.x.0

Build the Linux binaries:

.. code::

$ cd /path/to/uncrustify-uncrustify-0.1.2
$ cd /path/to/uncrustify-uncrustify-0.x.0
$ mkdir build
$ cd build
$ cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ..
Expand All @@ -250,7 +245,7 @@ Next, build the 32 and 64 bit Windows binaries:

.. code::

$ cd /path/to/uncrustify-uncrustify-0.1.2
$ cd /path/to/uncrustify-uncrustify-0.x.0
$ mkdir buildwin-32
$ cd buildwin-32
$ cmake -G Ninja \
Expand All @@ -263,7 +258,7 @@ Next, build the 32 and 64 bit Windows binaries:

.. code::

$ cd /path/to/uncrustify-uncrustify-0.1.2
$ cd /path/to/uncrustify-uncrustify-0.x.0
$ mkdir buildwin-64
$ cd buildwin-64
$ cmake -G Ninja \
Expand All @@ -284,30 +279,35 @@ Create a release on github
- Add the release version under "Release title" as "Uncrustify 0.xx.y"
- Upload the Windows binaries and the source code zip/tarball files in the section
"Attach binaries by dropping them here or selecting them": these will show up as
"Assets" under the release text. Executables for Windows 32 and 64 and source
code in tar.gz and zip format need to be uploaded.
"Assets" under the release text. The following files need to be added:
- buildwin-32/uncrustify-0.x.0_f-win32.zip
- buildwin-64/uncrustify-0.x.0_f-win64.zip
- uncrustify-0.x.0.tar.gz
- uncrustify-0.x.0.zip
- Add release text in describing section. It is recommended to copy the text
from previous releases and update the related files. Make sure to use bold text
to highlight the various sections (use '### ' at the beginning of the line)
to highlight the various sections (use '### ' at the beginning of the line).
You need to drag the files into the text section to get a link to the actual
files there. The same files mentioned above need to be added.
- Publish the release by clicking on the "Publish release" button.

Upload to SourceForge
=====================

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

* README.md
* uncrustify-0.1.2.tar.gz
* uncrustify-0.1.2.zip
* buildwin-32/uncrustify-0.1.2_f-win32.zip
* buildwin-64/uncrustify-0.1.2_f-win64.zip
* uncrustify-0.x.0.tar.gz
* uncrustify-0.x.0.zip
* buildwin-32/uncrustify-0.x.0_f-win32.zip
* buildwin-64/uncrustify-0.x.0_f-win64.zip

- Upload the documentation using the following commands:

Expand Down