erigon icon indicating copy to clipboard operation
erigon copied to clipboard

Instructions in readme cause people to build devel branch at random commits instead of release branches

Open PeaStew opened this issue 3 years ago • 5 comments

System information

image

These instructions really should have instructions on how to find the latest release branches for beta/alpha and how to check them out before building:

git clone --recurse-submodules -j8 https://github.com/ledgerwatch/erigon.git
cd erigon

<-- find <release branch> instructions -->

git checkout <release branch>
make erigon
./build/bin/erigon

PeaStew avatar Jul 19 '22 14:07 PeaStew

Latest Beta: https://github.com/ledgerwatch/erigon/releases?q=beta&expanded=true Latest Alpha: https://github.com/ledgerwatch/erigon/releases?q=alpha&expanded=true

PeaStew avatar Jul 19 '22 14:07 PeaStew

I'm not officially on the team, but you should make a PR instead of just an issue. I've done that in the past. The team is very open to useful additions to the README such as this.

Plus, I think you're absolutely right. Better instructions are needed. I've gotten bitten multiple times by building the wrong version.

tjayrush avatar Jul 19 '22 16:07 tjayrush

Now tags do not contain information: is it "beta" or "alpha". it's confusing. Only way to find release - search on github: https://github.com/ledgerwatch/erigon/issues/4756#issuecomment-1189148133 We will change naming of versions/tags soon - will add there clear label about beta/alpha/etc... For now we recommend: run latest "alpha" version.

AskAlexSharov avatar Jul 20 '22 05:07 AskAlexSharov

I'm not officially on the team, but you should make a PR instead of just an issue. I've done that in the past. The team is very open to useful additions to the README such as this.

Plus, I think you're absolutely right. Better instructions are needed. I've gotten bitten multiple times by building the wrong version.

Was asked by @mandrigin to make an issue specifically.

PeaStew avatar Jul 20 '22 05:07 PeaStew

Yep, I did ask for that, because even fixing now won’t really solve it until we promote the current alpha to stable. And then it’s a good time to update the docs.

mandrigin avatar Jul 20 '22 10:07 mandrigin

This issue is stale because it has been open for 40 days with no activity. Remove stale label or comment, or this will be closed in 7 days.

github-actions[bot] avatar Dec 29 '22 02:12 github-actions[bot]

This issue was closed because it has been stalled for 7 days with no activity.

github-actions[bot] avatar Jan 05 '23 02:01 github-actions[bot]