You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/organization.rst
+169-3Lines changed: 169 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -129,8 +129,174 @@ When Quark received a PR, the triage process is as below:
129
129
130
130
Release process
131
131
----------------
132
-
``Version: v1.1``
133
132
134
-
The Quark release process is as below:
133
+
``Version: v2.0``
134
+
135
+
Quark releases a new version every month. To streamline this process, we run a GitHub Actions workflow augmented by LLM, which handles the following tasks automatically:
136
+
137
+
138
+
#. Open an issue listing all changes merged since the last release.
139
+
#. Create a PR to update the version number and compose the changelog.
140
+
#. Generate a release draft.
141
+
142
+
The workflow is scheduled to start on the Monday preceding the first Wednesday of each month. On that day, we follow the process below to complete the release.
The release process starts on the Monday preceding the first Wednesday of each month. For example, the process for the **v25.10.1** release starts on **Monday, September 29, 2025**\ , since the following **Wednesday, October 1, 2025**\ , is the first Wednesday of October.
152
+
153
+
There are 6 steps in the process:
154
+
155
+
**Step 1. (Optional) Manually initiate the workflow for the GitHub release.**
156
+
157
+
.. note::
158
+
Normally, this step is unnecessary because the workflow will start automatically. If it fails to start, you can initiate it manually using the method below.
Click the gray ``Run workflow`` button and then the green ``Run workflow`` button. The workflow will create an issue and a PR approximately 5 minutes later.
And the PR updates the version number and changelog.
191
+
192
+
.. image:: https://i.postimg.cc/MKc3FVsB/pr.jpg
193
+
:target:https://i.postimg.cc/MKc3FVsB/pr.jpg
194
+
:alt:
195
+
196
+
197
+
**Step 2. Ensure the issue lists all changes since the last release.**
198
+
199
+
If the auto-generated issue omits any changes since the last release, edit the issue manually to include them. To edit the issue, click the ``...`` menu on the right and select ``Edit``.
Then, verify that Quark runs correctly in downstream projects such as Jadx and APKLab, and attach the result screenshots to the issue.
222
+
223
+
.. image:: https://i.postimg.cc/G2LdFqxG/jadx.jpg
224
+
:target:https://i.postimg.cc/G2LdFqxG/jadx.jpg
225
+
:alt:
226
+
227
+
228
+
**Step 4. Fix the problems caused by the changes.**
229
+
230
+
If the changes do not work correctly or break any features or downstream projects, fix the problem.
231
+
232
+
**Step 5. Ensure the PR is correct and merge it.**
233
+
234
+
The PR should update the version number in:
235
+
236
+
237
+
* ``debian/control``
238
+
* ``docs/source/conf.py``
239
+
* ``quark/__init__.py``
240
+
241
+
The PR should update the changelog in:
242
+
243
+
244
+
* ``debian/changelog``
245
+
246
+
If the auto-generated PR does not correctly update the version number and changelog, edit them manually by pushing your changes to the branch ``update_version_info_{VERSION_NUMBER}``. For example, if you want to edit the PR for the **v25.8.1** release, push your changes to the branch ``update_version_info_v25.8.1``.
247
+
248
+
249
+
.. image:: https://i.postimg.cc/zJtDRMGd/pr-e.jpg
250
+
:target:https://i.postimg.cc/zJtDRMGd/pr-e.jpg
251
+
:alt:
252
+
253
+
254
+
To merge the PR, first click the dropdown button 🔽 and select ``Squash and merge``.
If the auto-generated release draft cannot accurately describe the changes, edit it manually to provide a precise description. You can edit the release draft in the ``Write`` tab.
0 commit comments