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

documentation install.md - clone instructions - branch vs tag #835

Closed
dulhaver opened this issue Apr 17, 2024 · 3 comments
Closed

documentation install.md - clone instructions - branch vs tag #835

dulhaver opened this issue Apr 17, 2024 · 3 comments
Labels
bug Something isn't working invalid This doesn't seem right needs-info

Comments

@dulhaver
Copy link

dulhaver commented Apr 17, 2024

I am trying to follow the instructions @https://etcd.io/docs/v3.5/install/ to build etcd manually

I fail on the cloning
$ git clone -b v3.5.12 https://github.com/etcd-io/etcd.git , but can do it with
$ git clone -b release-3.5 https://github.com/etcd-io/etcd.git (branch instead of tag).

Somehow I feel it should be branch generally, not tag.

It that is so I'd try to create a PR for that change in https://github.com/etcd-io/website/blob/main/content/en/docs/v3.5/install.md

@jmhbnz
Copy link
Member

jmhbnz commented May 5, 2024

Hi @dulhaver - Thanks for your question. Running git clone -b v3.5.12 https://github.com/etcd-io/etcd.git works for me and should work in any modern git version. Can you please be more specific on what error you receive when attempting to clone the repository?

Cloning the tag is the intended approach as we want to refer to a specific release, not release-3.5 which is a branch that may have work in progress not yet ready for release.

@jmhbnz jmhbnz added invalid This doesn't seem right needs-info bug Something isn't working labels May 5, 2024
@ivanvc
Copy link
Member

ivanvc commented May 5, 2024

Related to: etcd-io/etcd#17894

I think the error that @dulhaver is reporting, is not really an error, but an info log from git, stating that the HEAD for a tag is detached.

@jmhbnz
Copy link
Member

jmhbnz commented May 5, 2024

Related to: etcd-io/etcd#17894

I think the error that @dulhaver is reporting, is not really an error, but an info log from git, stating that the HEAD for a tag is detached.

Thanks for the context - so in this case this is the expected/normal behavior when cloning a tag and is something controlled by git not by etcd project.

We need to stick with cloning a tag as etcd users need to clone released code, not the branch HEAD (unless they want latest unreleased changes and know what they are doing).

Closing as I don't believe any changes are required, please let me know if I am missing anything.

@jmhbnz jmhbnz closed this as not planned Won't fix, can't repro, duplicate, stale May 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working invalid This doesn't seem right needs-info
Projects
None yet
Development

No branches or pull requests

3 participants