https://linen.dev logo
Trouble Getting Started with Make
# help
b
I"m attempting to follow the website instructions on contributing to this project. I've forked the main shuttle repo and cloned it to my Mac. I'm having trouble with the make images command. I receive the error in the screenshot. I'm not sure how to resolve it.
Tried getting started on my Windows machine and am hitting the same type of error. I feel like there's a step missing somehow in the instructions.
k
Hey Blixus. 👋 A lot of the changes for
0.6.0
haven't been merged into
main
yet, but they likely will be on monday. In the meantime, if you use this branch: , it should work. Thanks for showing interest in contributing!
b
Thanks so much! I will hang on until everything is all matched up. In the meantime I need to start to understand the code base. I'm so used to fiddling around on my own with my own stuff.
I updated all the things to 0.7.0, still can't follow the instructions to spin up the local environment. make images still errors out. Am I still ahead of the game too much? More likely I'm too noobish for this.
k
I forgot to mention, it won't work on windows, as we haven't customized the Makefile to work on both unix and windows.
It should be as simple as possible to get started contributing, so any feedback on the process is valuable to us. We've also started the process of updating contributing.md, so the timing is good! And trust me, even experts have issues with makefiles. 😂
From a second look at your error, it looks like the root cause is
git describe --tags
is failing to read tags. Can you do a
git fetch upstream --tags
and try again (where upstream is the name of the shuttle remote repository, not your fork)?
b
I wondered about that...wsl 2 on windows would be ok I assume?
k
I believe that should be fine, yeah.
b
Bingo...the fetch tags thing is getting me over that hurdle, images are building.
Switched to wsl 2
I'd be tempted to add that tags bit as a troubleshooting step to the docs.
Looks like I'm off to the races. Thanks so much for your help!
k
Awesome!
By the way, and this is missing from the contributing doc, you should run this command as well after everything is setup:
docker compose --file docker-compose.rendered.yml --project-name shuttle-dev exec gateway /usr/local/bin/service --state=/var/lib/shuttle/gateway.sqlite init --name admin --key test-key
This will insert a superuser into the gateway DB, and then you can do the login step as written in the doc and creating projects in the dev environment should work.
You'll only need to run this command once, unless you clear the gateway docker volume
b
Did the --tags thing from my Mac...situation resolved there too. Will probably just use that platform for any shuttle contributions. I'm a wierd person who keeps one foot in the Mac and Windows camps 🙂
k
Nice! I have dual-boot windows/ubuntu myself, but I mostly use windows for gaming.