Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

crankstart cannot be included in a workspace as a git submodule #25

Open
sgeos opened this issue Dec 5, 2022 · 6 comments
Open

crankstart cannot be included in a workspace as a git submodule #25

sgeos opened this issue Dec 5, 2022 · 6 comments

Comments

@sgeos
Copy link

sgeos commented Dec 5, 2022

crankstart is workspace with one member. It cannot, therefore, be included in another Rust workspace as a git submodule. The workaround is to install crankstart and the user workspace in the same directory.

ideal directory structure

game_project_workspace/
game_project_workspace/crankstart/
game_project_workspace/game_core_library/
game_project_workspace/game_pc/
game_project_workspace/game_playdate/

workaround directory structure

crankstart/
game_project_workspace/
game_project_workspace/game_core_library/
game_project_workspace/game_pc/
game_project_workspace/game_playdate/

EDIT: Another workaround is probably to include crankstart as a git submodule and exclude it from the user workspace.

@rtsuk
Copy link
Collaborator

rtsuk commented Dec 5, 2022

I'd imagined you'd use crankstart as a dependency from crates, so this would not be an issue.

What are you trying to do where you want to include crankstart in your workspace?

@sgeos
Copy link
Author

sgeos commented Dec 6, 2022

I guess I wanted to put crankstart in the workspace because the instructions for using it include the following entries in Cargo.toml.

[dependencies]
crankstart = { path = "../crankstart" }
crankstart-sys = { path = "../crankstart/crankstart-sys" }

Dropping crankstart into the workspace would allow the above path to be used as is. At the time, crankstart and my project workspace were in completely different directories. Since I have a bunch of different things in my workspace, adding crankstart to the mix did not seem unreasonable. The directory structure is a lot like the one in my original post, only there are two libraries.

@rtsuk
Copy link
Collaborator

rtsuk commented Dec 6, 2022

Not unreasonable, but I favor leaving it as-it in expectation that it might eventually end up being published to crates.io.

@sgeos
Copy link
Author

sgeos commented Dec 7, 2022

Are there plans to publish to crates.io?

@rtsuk
Copy link
Collaborator

rtsuk commented Dec 7, 2022

Nothing more solid than an expectation.

@apollocatlin
Copy link

Would you be open to help? I would love to assist.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants