-
-
Notifications
You must be signed in to change notification settings - Fork 311
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
Update source.md - Default to stable branch #5207
Conversation
@coincashew Thanks for updating this but we can not merge changes directly to We actually did a update to the source installation docs a while ago but for it to update the actual docs page it needs to be in I opted for adding a note instead of directly specifying which branch should be cloned as I think if you run in prod it might even be best to specify a tag aka version instead of a branch. |
@nflaig users don't read notes they just copy commands (me included!) I think adding the stable branch as a safe default is good and additive to your note |
just need to adapt the note then as it currently says that |
@coincashew looks like prysm does not do this either, they default to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@coincashew This is definitely a good update to the docs and I think as @dapplion mentioned we should just add the -b stable
by default. Need to reopen this against the unstable
branch and do the docs updates there to avoid merge conflicts when merging unstable
to stable
.
The base branch was changed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we also need to update the warning or just remove it entirely
lodestar/docs/install/source.md
Lines 30 to 32 in e98d8e9
!!! warning | |
`git clone` will check out the default `unstable` branch. If you are running Lodestar in production, we recommend to either use the `stable` branch | |
by running `git switch stable` or to use a specific version by running `git checkout <version>`, e.g. `git checkout v1.3.0`. |
Removed warning, as requested by nflaig
Requested change made. Good feedback all around. Thanks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm, thanks for the update @coincashew
🎉 This PR is included in v1.7.0 🎉 |
Motivation
Safer: To make the default git cloning behavior for "build from source" production safe, thus avoiding any misunderstandings.
Common default branch: All other consensus clients github repos default to their respective stable branch.
Description
Adds stable branch flag to git clone operation.