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

Broken links and incomplete build tool list in CONTIRBUTING guide #19110

Closed
4 tasks done
jverce opened this issue Dec 27, 2024 · 0 comments · Fixed by #19111
Closed
4 tasks done

Broken links and incomplete build tool list in CONTIRBUTING guide #19110

jverce opened this issue Dec 27, 2024 · 0 comments · Fixed by #19111
Labels

Comments

@jverce
Copy link
Contributor

jverce commented Dec 27, 2024

Bug report criteria

What happened?

There were a couple of errors when running make verify by following the CONTRIBUTING.md guide in a fresh environment:

  1. jq is needed to run make verify-dep:

    root@dc1067d9dddc:/go/etcd# make verify-dep
    PASSES="dep" ./scripts/test.sh
    Running with --race
    Starting at: Fri Dec 27 16:43:41 UTC 2024
    
    'dep' started at Fri Dec 27 16:43:41 UTC 2024
    % (cd api && 'go' 'list' '-m')
    ./scripts/test.sh: line 514: jq: command not found
    % (cd api && 'go' 'mod' 'edit' '-json')
    FAIL: (code:141):
      % (cd api && 'go' 'mod' 'edit' '-json')
    There was a Failure in module api, aborting...
    FAIL: 'dep' FAILED at Fri Dec 27 16:43:41 UTC 2024
    make: *** [Makefile:90: verify-dep] Error 255
    
  2. xz is needed to run make verify-shellcheck:

    root@dc1067d9dddc:/go/etcd# make verify-shellcheck
    PASSES="shellcheck" ./scripts/test.sh
    Running with --race
    Starting at: Fri Dec 27 16:47:37 UTC 2024
    
    'shellcheck' started at Fri Dec 27 16:47:37 UTC 2024
    Tool: 'shellcheck' not found on PATH. https://github.com/koalaman/shellcheck#installing
    Installing shellcheck v0.10.0
    tar (grandchild): xz: Cannot exec: No such file or directory
    tar (grandchild): Error is not recoverable: exiting now
    tar: Child died with signal 13
    tar: Error is not recoverable: exiting now
    mv: cannot stat '/tmp/shellcheck': No such file or directory
    % './bin/shellcheck' '-fgcc' 'scripts/build-binary.sh' 'scripts/build-docker.sh' 'scripts/build-release.sh' 'scripts/build.sh' 'scripts/build_lib.sh' 'scripts/build_tools.sh' 'scripts/codecov_upload.sh' 'scripts/fix.sh' 'scripts/fuzzing.sh' 'scripts/genproto.sh' 'scripts/measure-testgrid-flakiness.sh' 'scripts/release.sh' 'scripts/release_mod.sh' 'scripts/sync_go_toolchain_directive.sh' 'scripts/test.sh' 'scripts/test_images.sh' 'scripts/test_lib.sh' 'scripts/update_dep.sh' 'scripts/update_proto_annotations.sh' 'scripts/updatebom.sh' 'scripts/verify_genproto.sh' 'scripts/verify_go_versions.sh' 'scripts/verify_proto_annotations.sh'
    FAIL: (code:127):
      % './bin/shellcheck' '-fgcc' 'scripts/build-binary.sh' 'scripts/build-docker.sh' 'scripts/build-release.sh' 'scripts/build.sh' 'scripts/build_lib.sh' 'scripts/build_tools.sh' 'scripts/codecov_upload.sh' 'scripts/fix.sh' 'scripts/fuzzing.sh' 'scripts/genproto.sh' 'scripts/measure-testgrid-flakiness.sh' 'scripts/release.sh' 'scripts/release_mod.sh' 'scripts/sync_go_toolchain_directive.sh' 'scripts/test.sh' 'scripts/test_images.sh' 'scripts/test_lib.sh' 'scripts/update_dep.sh' 'scripts/update_proto_annotations.sh' 'scripts/updatebom.sh' 'scripts/verify_genproto.sh' 'scripts/verify_go_versions.sh' 'scripts/verify_proto_annotations.sh'
    stderr: ./scripts/test_lib.sh: line 148: ./bin/shellcheck: No such file or directory
    
    FAIL: 'run ./bin/shellcheck -fgcc scripts/build-binary.sh scripts/build-docker.sh scripts/build-release.sh scripts/build.sh scripts/build_lib.sh scripts/build_tools.sh scripts/codecov_upload.sh scripts/fix.sh scripts/fuzzing.sh scripts/genproto.sh scripts/measure-testgrid-flakiness.sh scripts/release.sh scripts/release_mod.sh scripts/sync_go_toolchain_directive.sh scripts/test.sh scripts/test_images.sh scripts/test_lib.sh scripts/update_dep.sh scripts/update_proto_annotations.sh scripts/updatebom.sh scripts/verify_genproto.sh scripts/verify_go_versions.sh scripts/verify_proto_annotations.sh' checking failed (!=0 return code)
    FAIL: 'shellcheck' FAILED at Fri Dec 27 16:47:37 UTC 2024
    make: *** [Makefile:102: verify-shellcheck] Error 255
    
  3. The following links in the guide are no longer valid:

    1. https://github.com/golang/go/wiki/CodeReviewComments
    2. https://golangci-lint.run/usage/install/

What did you expect to happen?

make verify should succeed for all checks:

  1. make verify-dep:

    SUCCESS: dependencies are consistent across modules
    'dep' PASSED and completed at Fri Dec 27 16:47:05 UTC 2024
    SUCCESS
    
  2. make verify-shellcheck:

    'shellcheck' PASSED and completed at Fri Dec 27 16:48:47 UTC 2024
    SUCCESS
    

How can we reproduce it (as minimally and precisely as possible)?

  1. Run a Docker container with Go v1.23.4:

    docker run -it golang:1.23.4
  2. Clone this repo:

    git clone https://github.com/etcd-io/etcd.git
  3. Navigate to the repo:

    cd etcd
  4. Run make verify-dep and make verify-shellcheck

Anything else we need to know?

No response

Etcd version (please run commands below)

Running on top of this commit: a37bee0

Etcd configuration (command line flags or environment variables)

N/A

Etcd debug information (please run commands below, feel free to obfuscate the IP address or FQDN in the output)

N/A

Relevant log output

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging a pull request may close this issue.

1 participant