axodotdev / axodotdev/cargo-dist

Including submodules (recursively) in the source tarballs corresponding to a release

Open
#1,188 5 comments 0 reactions 0 assignees View on GitHub
feature request
Dominant language
Rust
Stars
2.1k
Forks
149
Avg merge
1d 11h
Merged PRs (30d)
32

Description

Hi!

This is a feature I've been wanting from GitHub forever, but I was wondering if it's possibly within the ecosystem of `cargo-dist`. Basically, when I tag a release and `cargo-dist` generates the relevant artifacts, is it possible to have the associated source tarballs include, recursively, the submodules in my repo? Right now this isn't the case (same with the tarballs GitHub provides as well), and so the program isn't able to be compiled from just the source tarball accompanying releases. However, I'd like the release tarballs to be "stand alone" and capable of being built directly.

Is such a thing possible? If so, how might I go about it?

Thanks!
Rob

Contributor guide

Open the contributing guide

Research direction

Start by tracing cargo-dist's release artifact generation and how source tarballs are assembled. Investigate whether Git submodules can be included recursively, then verify that a generated tarball contains the required submodule contents and builds independently from the archive.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, rust
Domain
build-system, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.