Update GitHub release process in the docs

[zinwang]

Release process

Version: v2.0

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:

1. Open an issue listing all changes merged since the last release.
2. Create a PR to update the version number and compose the changelog.
3. Generate a release draft.

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.

Note

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:

Step 1. (Optional) Manually initiate the workflow for the GitHub release.

Note

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 Quark's GitHub page.

Click the Generate GitHub Release Issue/PR workflow in the left sidebar.

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.

The issue lists all PRs merged since the last release.

And the PR updates the version number and changelog.

Step 2. Ensure the issue lists all changes since the last release.

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.

Step 3. Test whether the new changes work correctly and do not break any features or downstream projects.

First, verify that all change listed in the issue works as intended.

Next, verify that all CI checks for the PR have passed.

Then, verify that Quark runs correctly in downstream projects such as Jadx and APKLab, and attach the result screenshots to the issue.

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 is correct and merge it.

The PR should update the version number in:

• debian/control
• docs/source/conf.py
• quark/__init__.py

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 for the v25.8.1 release, push your changes to the branch update_version_info_v25.8.1.

To merge the PR, first click the dropdown button 🔽 and select Squash and merge.

Next, click the Squash and merge button.

Verify the commit message. Then, click the Confirm squash and merge button to complete the merge.

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.

Click the pencil button.

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.

To publish the release, click the Publish release button.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.94%. Comparing base (2d0890e) to head (6f67867).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #791   +/-   ##
=======================================
  Coverage   80.94%   80.94%           
=======================================
  Files          75       75           
  Lines        6308     6308           
=======================================
  Hits         5106     5106           
  Misses       1202     1202           

Flag	Coverage Δ
unittests	80.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[zinwang]

Resolves #795

[haeter525]

Thank @zinwang for the document update. Nice work.

[sidra-asa]

LGTM. Thank you.