Hi all, I am stuck with setting up caravel_user_p...
# caravel
h
Hi all, I am stuck with setting up caravel_user_project: Is there a clear description how to clone the repo, rename it, and install it so that it still works?
1
t
I would have assumed that the readthedocs link provided at the top of the page on github would give instructions that work. If not, please let me know, and also @User. As is usually the case, the various bits and pieces of the whole system change over time and documentation is the last thing to be fixed up, so "not working as advertised" is a common state.
j
there are a few options, but i’d recommend doing a git clone of caravel_user_project and then
Copy code
$ git remote set-url origin <http://github.com/YOU/YOUR_REPO>
$ git push origin main
h
@User Thanks for the hint, I’ll try this.
@User What I find lacking in the provided instructions: What to do step-by-step to setup caravel_user_project incl. setting the right version of everything. If you just use latest everywhile it does not work (at least in my case). So the provided instructions in GitHub or readthedocs should by augmented by the commands to get the versions right.
m
Harald, use my scripts here until efabless announce the working tool tags
that has all the commits and tags and environment variables to get thigns working. It's quite old now though, mpw3-a, though I used it also for mpw4
h
Thanks @User I used your project as base, and it was working first, then suddenly stopped working, and I was completely lost. I have now baked everything into shell scripts, and it works now 🙂 I figured what killed it, one should NOT set
export CARAVEL_LITE=0
, then git gets confused regarding the labels.
@User thanks for the help with the git commands. I followed you advice, and now when I do a git push I have to do
git push origin HEAD:main
. Any hint what I need to do that a simple
git pull
and
git push
will do?
m
you should also turn off the 'auto update submodules' github action. That can be really confusing. If you clone the repo to another computer you'll probably find the submodule will have changed commit and things will appear to have randomly stopped working.
git push -u origin main
that would set the tracking branch to be main, but in your case you probably don't want it because you're not on main any more
I always checkout a new branch that matches the shuttle run: git checkout -b mpw5; git push -u origin mpw5. Also that will only work if you delete the efabless origin and add your own origin.
h
I see, I am a complete git dummy. If I setup a local repo based on your recipe, how could I rename it and push to GitHub properly?
using exactly this
Copy code
$ git remote set-url origin <http://github.com/YOU/YOUR_REPO>
$ git push origin main
did not work, as username/password are not allowed anymore on GitHub, and I use my SSH credentials.
m
git checkout -b mpw5 # make a new branch git remote remove origin # remove the remote origin git remote add origin <your github url> # add your github repo as the new origin git push -u origin mpw5 # push your local branch to the github repo
use the git@github.com:<yourname>/repo.git format
h
Super, works ! 🙂 🙂 Final questions (I hope): How can I make sure that the efabless site pulls the correct branch? I have to add the GitHub link there. It this set by the default branch in GitHub?
m
what I do is create a new repo on github, then when I push my mpw5 branch it is the only (and hence default) branch
if you have multiple branches you need to go to the repo settings in github and choose which branch is the default. that will be the one that efabless pulls
h
👍