rustdesk / rustdesk/rustdesk-server

GitHub release - Source code assets are missing /libs/hbb_common submodule

Open
#701 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Rust
Stars
10.4k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
GitHub releases of source code tarballs (both .zip. and .tar.gz) are missing the /libs/hbb_common submodule.

The folder is present, but is empty.

For example:
Source code (tar.gz) for version 1.1.16.
Image

This has been happening ever since version 1.1.13 (version 1.1.12 is the last one that contains the submodule)

Describe the environment
Source code releases from versions 1.1.13 (including) going forward.

How to Reproduce the bug
Steps to reproduce the behavior:

  1. Go to releases page
  2. Download a source code (.zip or .tar.gz)
  3. Unpack
  4. Observe contents of /libs/hbb_common directory is empty
  5. [optional] Attempt to build the application
error: failed to load manifest for workspace member `rustdesk-server-1.1.16/libs/hbb_common`

Expected behavior
Source release should contain every submodule required to build the application.

Additional context
I believe it is caused by GitHub not including git submodules in automatically generated source code tarballs.
Since 1.1.13 (specifically Commit 7a509f6) the hbb_common lib is added as a submodule.

Possible solution would be to build the tarballs manually inside the build workflow.

References:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with .github/workflows/build.yaml and review how source release archives are produced, then compare the 1.1.12 and 1.1.13 release contents around libs/hbb_common. Reproduce the archive download and unpack steps, and verify that the resulting source archive includes the submodule and can load the workspace manifest successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github-actions, rust
Domain
build-system, ci-cd, release
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.