From d1a18f8f87394f487fea6cad81b727ef054d43af Mon Sep 17 00:00:00 2001 From: zinwang Date: Tue, 12 Aug 2025 08:38:16 +0800 Subject: [PATCH 1/6] Update github release process --- docs/source/organization.rst | 120 ++++++++++++++++++++++++++++++++++- 1 file changed, 118 insertions(+), 2 deletions(-) diff --git a/docs/source/organization.rst b/docs/source/organization.rst index 15425ae3b..a080319a1 100644 --- a/docs/source/organization.rst +++ b/docs/source/organization.rst @@ -129,8 +129,124 @@ When Quark received a PR, the triage process is as below: Release process ---------------- -``Version: v1.1`` +``Version: v2.0`` The Quark release process is as below: -.. image:: https://i.imgur.com/WtN2eLi.png + +.. image:: https://i.postimg.cc/NsK6mCmt/github-release-drawio.png + :target: https://i.postimg.cc/NsK6mCmt/github-release-drawio.png + :alt: + + +:::info +Note: The process starts on the Monday of the week contains a first Wednesday of the month (e.g. **Monday, September 29th, 2025**\ ). +:: + +There are 6 main steps in the process: + +**1. Initiate the CI for GitHub release manually** + +Under normal circumstances, this step is not required, as the CI will be triggered automatically.However, if the CI does not trigger correctly, it can be manually triggered using the following method. + +Click the ``Actions`` tab on the GitHub page of Quark. + +.. image:: https://i.postimg.cc/MHW9J1nc/tpBB18r.png + :target: https://i.postimg.cc/MHW9J1nc/tpBB18r.png + :alt: + + +Click ``Generate GitHub Release Issue/PR`` workflow in the left sidebar. + +.. image:: https://i.postimg.cc/YC4b7rCx/Screenshot-2025-08-11-15-59-41-1.png + :target: https://i.postimg.cc/YC4b7rCx/Screenshot-2025-08-11-15-59-41-1.png + :alt: + + +Click ``Run workflow`` and then ``Run workflow``. + +.. image:: https://i.postimg.cc/63hhcTMB/Screenshot-2025-08-11-16-07-17.png + :target: https://i.postimg.cc/63hhcTMB/Screenshot-2025-08-11-16-07-17.png + :alt: + + +The workflow will generate the issue and the PR around 10 minutes later. + +The generated issue: + +.. image:: https://hackmd.io/_uploads/rkP55ludxe.png + :target: https://hackmd.io/_uploads/rkP55ludxe.png + :alt: + + +The generated PR: + +.. image:: https://i.postimg.cc/XY1NG0dq/Screenshot-2025-08-12-07-33-23.png + :target: https://postimg.cc/Sn8b33Zb + :alt: Screenshot-2025-08-12-07-33-23.png + + +**2. Adjust the content of the issue** + + +.. image:: https://i.postimg.cc/j5HrXVwz/Screenshot-2025-08-12-07-35-15-0.png + :target: https://postimg.cc/2bSJkKx6 + :alt: Screenshot-2025-08-12-07-35-15-0.png + + +**3. Test Quark in downstream** + +Test if Quark can run properly in the downstreams like Jadx or APKLab, and paste the screenshot of result under the issue for the release. + +.. image:: https://i.postimg.cc/kgL3PMWQ/Screenshot-2025-08-12-07-37-38.png + :target: https://postimg.cc/751Qgksh + :alt: Screenshot-2025-08-12-07-37-38.png + + +**4. Fix broken functions** + +If Quark cannot fails to run analysis in the downstreams, fix the problem. + +**5. Adjust the content of the PR and merge it** + +To Adjust the content: + +.. image:: https://i.postimg.cc/rpqbkdKt/Screenshot-2025-08-12-07-41-14-1.png + :target: https://postimg.cc/bZFL0w0z + :alt: Screenshot-2025-08-12-07-41-14-1.png + + +To merge the PR: + +.. image:: https://i.postimg.cc/PqrjMVbc/Screenshot-2025-08-12-07-41-14-2.png + :target: https://postimg.cc/sM8qjcN9 + :alt: Screenshot-2025-08-12-07-41-14-2.png + + +**6. Adjust the draft of the release and publish it** + + +.. image:: https://i.postimg.cc/zfC18ZzV/Screenshot-2025-08-12-07-46-21.png + :target: https://postimg.cc/7CZRnRTk + :alt: Screenshot-2025-08-12-07-46-21.png + + + +.. image:: https://i.postimg.cc/X7GmnSx4/Screenshot-2025-08-12-07-47-19-1.png + :target: https://postimg.cc/1fSJKdLj + :alt: Screenshot-2025-08-12-07-47-19-1.png + + +To adjust the content: + +.. image:: https://i.postimg.cc/pTrkkz6R/Screenshot-2025-08-12-07-48-19.png + :target: https://postimg.cc/hzF9tzn5 + :alt: Screenshot-2025-08-12-07-48-19.png + + +To publish the release: + +.. image:: https://i.postimg.cc/c1gGLn4p/Screenshot-2025-08-12-07-48-56.png + :target: https://postimg.cc/c6SbD63h + :alt: Screenshot-2025-08-12-07-48-56.png + From 0b58ef6c7b420c59efa67cf70e96a12858cb915e Mon Sep 17 00:00:00 2001 From: zinwang Date: Tue, 12 Aug 2025 11:57:12 +0800 Subject: [PATCH 2/6] Update github release process --- docs/source/organization.rst | 104 +++++++++++++++++++++-------------- 1 file changed, 62 insertions(+), 42 deletions(-) diff --git a/docs/source/organization.rst b/docs/source/organization.rst index a080319a1..e678780f6 100644 --- a/docs/source/organization.rst +++ b/docs/source/organization.rst @@ -129,6 +129,7 @@ When Quark received a PR, the triage process is as below: Release process ---------------- + ``Version: v2.0`` The Quark release process is as below: @@ -139,15 +140,17 @@ The Quark release process is as below: :alt: -:::info -Note: The process starts on the Monday of the week contains a first Wednesday of the month (e.g. **Monday, September 29th, 2025**\ ). -:: +.. note:: + The process starts on the Monday before the first Wednesday of a month (e.g. **Monday, September 29th, 2025**\ ). + -There are 6 main steps in the process: +There are 6 steps in the process: **1. Initiate the CI for GitHub release manually** -Under normal circumstances, this step is not required, as the CI will be triggered automatically.However, if the CI does not trigger correctly, it can be manually triggered using the following method. +.. note:: + Normally, this step is unnecessary because the CI triggers automatically. If it fails to trigger, you can start it manually using the method below. + Click the ``Actions`` tab on the GitHub page of Quark. @@ -158,95 +161,112 @@ Click the ``Actions`` tab on the GitHub page of Quark. Click ``Generate GitHub Release Issue/PR`` workflow in the left sidebar. -.. image:: https://i.postimg.cc/YC4b7rCx/Screenshot-2025-08-11-15-59-41-1.png - :target: https://i.postimg.cc/YC4b7rCx/Screenshot-2025-08-11-15-59-41-1.png + +.. image:: https://i.postimg.cc/Jn2WCmj4/ci-issue-pr.jpg + :target: https://i.postimg.cc/Jn2WCmj4/ci-issue-pr.jpg :alt: -Click ``Run workflow`` and then ``Run workflow``. +Click ``Run workflow`` and then ``Run workflow``. The workflow will create an issue and a PR approximately 10 minutes later. .. image:: https://i.postimg.cc/63hhcTMB/Screenshot-2025-08-11-16-07-17.png :target: https://i.postimg.cc/63hhcTMB/Screenshot-2025-08-11-16-07-17.png :alt: -The workflow will generate the issue and the PR around 10 minutes later. +The issue lists all PRs merged since the last release. -The generated issue: - -.. image:: https://hackmd.io/_uploads/rkP55ludxe.png - :target: https://hackmd.io/_uploads/rkP55ludxe.png +.. image:: https://i.postimg.cc/MGcGcstT/issue.jpg + :target: https://i.postimg.cc/MGcGcstT/issue.jpg :alt: -The generated PR: +And the PR updates the changelog and version information. -.. image:: https://i.postimg.cc/XY1NG0dq/Screenshot-2025-08-12-07-33-23.png - :target: https://postimg.cc/Sn8b33Zb - :alt: Screenshot-2025-08-12-07-33-23.png +.. image:: https://i.postimg.cc/MKc3FVsB/pr.jpg + :target: https://i.postimg.cc/MKc3FVsB/pr.jpg + :alt: **2. Adjust the content of the issue** +To edit the auto-generated issue, click the ``...`` menu on the right and select ``Edit``. -.. image:: https://i.postimg.cc/j5HrXVwz/Screenshot-2025-08-12-07-35-15-0.png - :target: https://postimg.cc/2bSJkKx6 - :alt: Screenshot-2025-08-12-07-35-15-0.png +.. image:: https://i.postimg.cc/hPM6kKgF/Screenshot-2025-08-12-07-35-15.png + :target: https://i.postimg.cc/hPM6kKgF/Screenshot-2025-08-12-07-35-15.png + :alt: **3. Test Quark in downstream** -Test if Quark can run properly in the downstreams like Jadx or APKLab, and paste the screenshot of result under the issue for the release. +Verify that Quark runs correctly in downstream projects such as Jadx or APKLab, and attach the screenshots of the results to the issue. -.. image:: https://i.postimg.cc/kgL3PMWQ/Screenshot-2025-08-12-07-37-38.png - :target: https://postimg.cc/751Qgksh - :alt: Screenshot-2025-08-12-07-37-38.png +.. image:: https://i.postimg.cc/G2LdFqxG/jadx.jpg + :target: https://i.postimg.cc/G2LdFqxG/jadx.jpg + :alt: **4. Fix broken functions** -If Quark cannot fails to run analysis in the downstreams, fix the problem. +If Quark fails to run analysis in downstream projects, resolve the problem. **5. Adjust the content of the PR and merge it** -To Adjust the content: +To edit the auto-generated PR, click the ``...`` menu on the right and select ``Edit``. + +.. image:: https://i.postimg.cc/7YWhx8Mc/pr-edit.jpg + :target: https://i.postimg.cc/7YWhx8Mc/pr-edit.jpg + :alt: + + +To merge the PR, first click the downward button 🔽 and select ``Squash and merge``. + +.. image:: https://i.postimg.cc/4x2SLwGp/merge-pr-1.jpg + :target: https://i.postimg.cc/4x2SLwGp/merge-pr-1.jpg + :alt: + + +Next, click the green ``Squash and merge`` button. -.. image:: https://i.postimg.cc/rpqbkdKt/Screenshot-2025-08-12-07-41-14-1.png - :target: https://postimg.cc/bZFL0w0z - :alt: Screenshot-2025-08-12-07-41-14-1.png +.. image:: https://i.postimg.cc/T3Bc5sGN/merge-pr-2.jpg + :target: https://i.postimg.cc/T3Bc5sGN/merge-pr-2.jpg + :alt: -To merge the PR: +If the commit message is correct, click ``Confirm squash and merge`` to complete the merge. -.. image:: https://i.postimg.cc/PqrjMVbc/Screenshot-2025-08-12-07-41-14-2.png - :target: https://postimg.cc/sM8qjcN9 - :alt: Screenshot-2025-08-12-07-41-14-2.png +.. image:: https://i.postimg.cc/hPyscjYB/merge-pr-3.jpg + :target: https://i.postimg.cc/hPyscjYB/merge-pr-3.jpg + :alt: **6. Adjust the draft of the release and publish it** +Click ``Releases`` on Quark’s main GitHub page and you can see the auto-generated release draft. -.. image:: https://i.postimg.cc/zfC18ZzV/Screenshot-2025-08-12-07-46-21.png - :target: https://postimg.cc/7CZRnRTk - :alt: Screenshot-2025-08-12-07-46-21.png +.. image:: https://i.postimg.cc/SN6XftWt/release-01.jpg + :target: https://i.postimg.cc/SN6XftWt/release-01.jpg + :alt: +Click the pencil button. .. image:: https://i.postimg.cc/X7GmnSx4/Screenshot-2025-08-12-07-47-19-1.png - :target: https://postimg.cc/1fSJKdLj - :alt: Screenshot-2025-08-12-07-47-19-1.png + :target: https://i.postimg.cc/X7GmnSx4/Screenshot-2025-08-12-07-47-19-1.png + :alt: -To adjust the content: +To edit the auto-generated release note, modify it in the ``Write`` window. .. image:: https://i.postimg.cc/pTrkkz6R/Screenshot-2025-08-12-07-48-19.png - :target: https://postimg.cc/hzF9tzn5 - :alt: Screenshot-2025-08-12-07-48-19.png + :target: https://i.postimg.cc/pTrkkz6R/Screenshot-2025-08-12-07-48-19.png + :alt: -To publish the release: +To complete the publication, click ``Publish release``. .. image:: https://i.postimg.cc/c1gGLn4p/Screenshot-2025-08-12-07-48-56.png :target: https://postimg.cc/c6SbD63h :alt: Screenshot-2025-08-12-07-48-56.png + From c85169b0304469dd20079f59f63bb53f55048aa3 Mon Sep 17 00:00:00 2001 From: zinwang Date: Thu, 14 Aug 2025 00:23:24 +0800 Subject: [PATCH 3/6] Fix grammar issues --- docs/source/organization.rst | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/source/organization.rst b/docs/source/organization.rst index e678780f6..7753ae381 100644 --- a/docs/source/organization.rst +++ b/docs/source/organization.rst @@ -132,16 +132,16 @@ Release process ``Version: v2.0`` -The Quark release process is as below: +The Quark release process is as follows: -.. image:: https://i.postimg.cc/NsK6mCmt/github-release-drawio.png - :target: https://i.postimg.cc/NsK6mCmt/github-release-drawio.png +.. image:: https://i.postimg.cc/w9R4Xxh7/github-release-drawio-2.png + :target: https://i.postimg.cc/w9R4Xxh7/github-release-drawio-2.png :alt: .. note:: - The process starts on the Monday before the first Wednesday of a month (e.g. **Monday, September 29th, 2025**\ ). + The process begins on the Monday before the first Wednesday of each month (e.g., **Monday, September 29, 2025**\ ). There are 6 steps in the process: @@ -151,7 +151,6 @@ There are 6 steps in the process: .. note:: Normally, this step is unnecessary because the CI triggers automatically. If it fails to trigger, you can start it manually using the method below. - Click the ``Actions`` tab on the GitHub page of Quark. .. image:: https://i.postimg.cc/MHW9J1nc/tpBB18r.png @@ -197,9 +196,9 @@ To edit the auto-generated issue, click the ``...`` menu on the right and select :alt: -**3. Test Quark in downstream** +**3. Test Quark in the downstream** -Verify that Quark runs correctly in downstream projects such as Jadx or APKLab, and attach the screenshots of the results to the issue. +Verify that Quark runs correctly in downstream projects such as Jadx or APKLab, and attach the screenshots of results to the issue. .. image:: https://i.postimg.cc/G2LdFqxG/jadx.jpg :target: https://i.postimg.cc/G2LdFqxG/jadx.jpg @@ -219,7 +218,7 @@ To edit the auto-generated PR, click the ``...`` menu on the right and select `` :alt: -To merge the PR, first click the downward button 🔽 and select ``Squash and merge``. +To merge the PR, first click the dropdown button 🔽 and select ``Squash and merge``. .. image:: https://i.postimg.cc/4x2SLwGp/merge-pr-1.jpg :target: https://i.postimg.cc/4x2SLwGp/merge-pr-1.jpg @@ -242,7 +241,7 @@ If the commit message is correct, click ``Confirm squash and merge`` to complete **6. Adjust the draft of the release and publish it** -Click ``Releases`` on Quark’s main GitHub page and you can see the auto-generated release draft. +Click ``Releases`` on Quark’s main GitHub page, and you can see the auto-generated release draft. .. image:: https://i.postimg.cc/SN6XftWt/release-01.jpg :target: https://i.postimg.cc/SN6XftWt/release-01.jpg @@ -256,7 +255,7 @@ Click the pencil button. :alt: -To edit the auto-generated release note, modify it in the ``Write`` window. +To edit the auto-generated release notes, modify them in the ``Write`` window. .. image:: https://i.postimg.cc/pTrkkz6R/Screenshot-2025-08-12-07-48-19.png :target: https://i.postimg.cc/pTrkkz6R/Screenshot-2025-08-12-07-48-19.png From 580d8369f4ef0e47329c1c8d187d2d4b0be3a6de Mon Sep 17 00:00:00 2001 From: zinwang Date: Tue, 19 Aug 2025 22:25:33 +0800 Subject: [PATCH 4/6] Update docs fot github release --- docs/source/organization.rst | 88 ++++++++++++++++++++++++------------ 1 file changed, 58 insertions(+), 30 deletions(-) diff --git a/docs/source/organization.rst b/docs/source/organization.rst index 7753ae381..ac0b864e7 100644 --- a/docs/source/organization.rst +++ b/docs/source/organization.rst @@ -132,41 +132,48 @@ Release process ``Version: v2.0`` -The Quark release process is as follows: +Quark releases a new version every month. To streamline this process, we use a GitHub workflow that summarizes changes and automatically updates the version number and changelog. The workflow is scheduled to perform the following 3 tasks on the Monday preceding the first Wednesday of each month: -.. image:: https://i.postimg.cc/w9R4Xxh7/github-release-drawio-2.png - :target: https://i.postimg.cc/w9R4Xxh7/github-release-drawio-2.png +#. Open an issue listing all changes merged since the last release. +#. Create a PR to update the version number and changelog. +#. Generate a release draft. + +Once the scheduled time arrives, we follow the process below to complete the release: + + +.. image:: https://i.postimg.cc/cZXHqvWq/github-release-drawio-12.png + :target: https://i.postimg.cc/cZXHqvWq/github-release-drawio-12.png :alt: .. note:: - The process begins on the Monday before the first Wednesday of each month (e.g., **Monday, September 29, 2025**\ ). - + 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. There are 6 steps in the process: -**1. Initiate the CI for GitHub release manually** +**Step 1. (Optional) Manually initiate the workflow for the GitHub release.** .. note:: - Normally, this step is unnecessary because the CI triggers automatically. If it fails to trigger, you can start it manually using the method below. + 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 ``Actions`` tab on the GitHub page of Quark. +Click the ``Actions`` tab on Quark's GitHub page. .. image:: https://i.postimg.cc/MHW9J1nc/tpBB18r.png :target: https://i.postimg.cc/MHW9J1nc/tpBB18r.png :alt: -Click ``Generate GitHub Release Issue/PR`` workflow in the left sidebar. +Click the ``Generate GitHub Release Issue/PR`` workflow in the left sidebar. -.. image:: https://i.postimg.cc/Jn2WCmj4/ci-issue-pr.jpg - :target: https://i.postimg.cc/Jn2WCmj4/ci-issue-pr.jpg +.. image:: https://i.postimg.cc/7YDJ7Hpn/Screenshot-2025-08-17-11-55-37.png + :target: https://i.postimg.cc/7YDJ7Hpn/Screenshot-2025-08-17-11-55-37.png :alt: -Click ``Run workflow`` and then ``Run workflow``. The workflow will create an issue and a PR approximately 10 minutes later. +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. .. image:: https://i.postimg.cc/63hhcTMB/Screenshot-2025-08-11-16-07-17.png :target: https://i.postimg.cc/63hhcTMB/Screenshot-2025-08-11-16-07-17.png @@ -180,41 +187,63 @@ The issue lists all PRs merged since the last release. :alt: -And the PR updates the changelog and version information. +And the PR updates the version number and changelog. .. image:: https://i.postimg.cc/MKc3FVsB/pr.jpg :target: https://i.postimg.cc/MKc3FVsB/pr.jpg :alt: -**2. Adjust the content of the issue** +**Step 2. Ensure the issue lists all changes since the last release.** -To edit the auto-generated issue, click the ``...`` menu on the right and select ``Edit``. +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``. .. image:: https://i.postimg.cc/hPM6kKgF/Screenshot-2025-08-12-07-35-15.png :target: https://i.postimg.cc/hPM6kKgF/Screenshot-2025-08-12-07-35-15.png :alt: -**3. Test Quark in the downstream** +**Step 3. Test whether the new changes work correctly and do not break any features or downstream projects.** + +First, verify that every change works as intended. + +Next, verify that all CI checks for the PR have passed. + +.. image:: https://i.postimg.cc/2CqZ5xDv/cicheck.jpg + :target: https://i.postimg.cc/2CqZ5xDv/cicheck.jpg + :alt: + -Verify that Quark runs correctly in downstream projects such as Jadx or APKLab, and attach the screenshots of results to the issue. +Then, verify that Quark runs correctly in downstream projects such as Jadx and APKLab, and attach the result screenshots to the issue. .. image:: https://i.postimg.cc/G2LdFqxG/jadx.jpg :target: https://i.postimg.cc/G2LdFqxG/jadx.jpg :alt: -**4. Fix broken functions** +**Step 4. Fix the problems caused by the changes.** + +If the changes do not work correctly or break any features or downstream projects, fix the problem. + +**Step 5. Ensure the PR correctly updates the version number and changelog, then merge it.** + +The PR should update the version number in: + -If Quark fails to run analysis in downstream projects, resolve the problem. +* ``debian/control`` +* ``docs/source/conf.py`` +* ``quark/__init__.py`` -**5. Adjust the content of the PR and merge it** +The PR should update the changelog in: -To edit the auto-generated PR, click the ``...`` menu on the right and select ``Edit``. -.. image:: https://i.postimg.cc/7YWhx8Mc/pr-edit.jpg - :target: https://i.postimg.cc/7YWhx8Mc/pr-edit.jpg +* ``debian/changelog`` + +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 of the **v25.8.1** release, push your changes to the branch ``update_version_info_v25.8.1``. + + +.. image:: https://i.postimg.cc/zJtDRMGd/pr-e.jpg + :target: https://i.postimg.cc/zJtDRMGd/pr-e.jpg :alt: @@ -225,23 +254,23 @@ To merge the PR, first click the dropdown button 🔽 and select ``Squash and me :alt: -Next, click the green ``Squash and merge`` button. +Next, click the ``Squash and merge`` button. .. image:: https://i.postimg.cc/T3Bc5sGN/merge-pr-2.jpg :target: https://i.postimg.cc/T3Bc5sGN/merge-pr-2.jpg :alt: -If the commit message is correct, click ``Confirm squash and merge`` to complete the merge. +Verify the commit message. Then, click the ``Confirm squash and merge`` button to complete the merge. .. image:: https://i.postimg.cc/hPyscjYB/merge-pr-3.jpg :target: https://i.postimg.cc/hPyscjYB/merge-pr-3.jpg :alt: -**6. Adjust the draft of the release and publish it** +**Step 6. Ensure the release draft accurately describes the changes, then publish it.** -Click ``Releases`` on Quark’s main GitHub page, and you can see the auto-generated release draft. +Click the ``Releases`` link on Quark’s GitHub page, and you can see the auto-generated release draft. .. image:: https://i.postimg.cc/SN6XftWt/release-01.jpg :target: https://i.postimg.cc/SN6XftWt/release-01.jpg @@ -255,17 +284,16 @@ Click the pencil button. :alt: -To edit the auto-generated release notes, modify them in the ``Write`` window. +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. .. image:: https://i.postimg.cc/pTrkkz6R/Screenshot-2025-08-12-07-48-19.png :target: https://i.postimg.cc/pTrkkz6R/Screenshot-2025-08-12-07-48-19.png :alt: -To complete the publication, click ``Publish release``. +To publish the release, click the ``Publish release`` button. .. image:: https://i.postimg.cc/c1gGLn4p/Screenshot-2025-08-12-07-48-56.png :target: https://postimg.cc/c6SbD63h :alt: Screenshot-2025-08-12-07-48-56.png - From 46fa05be474054e837fad4e41c062179bf87d67f Mon Sep 17 00:00:00 2001 From: zinwang Date: Tue, 19 Aug 2025 23:26:24 +0800 Subject: [PATCH 5/6] Update docs fot github release --- docs/source/organization.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/source/organization.rst b/docs/source/organization.rst index ac0b864e7..e6fee5706 100644 --- a/docs/source/organization.rst +++ b/docs/source/organization.rst @@ -205,7 +205,11 @@ If the auto-generated issue omits any changes since the last release, edit the i **Step 3. Test whether the new changes work correctly and do not break any features or downstream projects.** -First, verify that every change works as intended. +First, verify that all change listed in the issue works as intended. + +.. image:: https://i.postimg.cc/MGcGcstT/issue.jpg + :target: https://i.postimg.cc/MGcGcstT/issue.jpg + :alt: Next, verify that all CI checks for the PR have passed. @@ -239,7 +243,7 @@ The PR should update the changelog in: * ``debian/changelog`` -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 of the **v25.8.1** release, push your changes to the branch ``update_version_info_v25.8.1``. +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``. .. image:: https://i.postimg.cc/zJtDRMGd/pr-e.jpg From 6f67867098218f070da5df5a281d71fafe77d40a Mon Sep 17 00:00:00 2001 From: zinwang Date: Thu, 21 Aug 2025 00:55:00 +0800 Subject: [PATCH 6/6] Update docs for github release --- docs/source/organization.rst | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/source/organization.rst b/docs/source/organization.rst index e6fee5706..f70855673 100644 --- a/docs/source/organization.rst +++ b/docs/source/organization.rst @@ -132,18 +132,18 @@ Release process ``Version: v2.0`` -Quark releases a new version every month. To streamline this process, we use a GitHub workflow that summarizes changes and automatically updates the version number and changelog. The workflow is scheduled to perform the following 3 tasks on the Monday preceding the first Wednesday of each month: +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: #. Open an issue listing all changes merged since the last release. -#. Create a PR to update the version number and changelog. +#. Create a PR to update the version number and compose the changelog. #. Generate a release draft. -Once the scheduled time arrives, we follow the process below to complete the release: +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. -.. image:: https://i.postimg.cc/cZXHqvWq/github-release-drawio-12.png - :target: https://i.postimg.cc/cZXHqvWq/github-release-drawio-12.png +.. image:: https://i.postimg.cc/gYVXBDMp/github-release-drawio-14.png + :target: https://i.postimg.cc/gYVXBDMp/github-release-drawio-14.png :alt: @@ -229,7 +229,7 @@ Then, verify that Quark runs correctly in downstream projects such as Jadx and A If the changes do not work correctly or break any features or downstream projects, fix the problem. -**Step 5. Ensure the PR correctly updates the version number and changelog, then merge it.** +**Step 5. Ensure the PR is correct and merge it.** The PR should update the version number in: @@ -272,7 +272,7 @@ Verify the commit message. Then, click the ``Confirm squash and merge`` button t :alt: -**Step 6. Ensure the release draft accurately describes the changes, then publish it.** +**Step 6. Ensure the release draft is accurate and publish it.** Click the ``Releases`` link on Quark’s GitHub page, and you can see the auto-generated release draft. @@ -300,4 +300,3 @@ To publish the release, click the ``Publish release`` button. .. image:: https://i.postimg.cc/c1gGLn4p/Screenshot-2025-08-12-07-48-56.png :target: https://postimg.cc/c6SbD63h :alt: Screenshot-2025-08-12-07-48-56.png -