open-telemetry / open-telemetry/opentelemetry-python-contrib
Development workflow should not run "sudo"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
Running tox causes it to call sudo:
generate-workflows: OK ✔ in 4.59 seconds
shellcheck: recreate env because python changed virtualenv version='20.26.2'->'20.28.1'
shellcheck: remove tox env folder /usr/local/google/home/michaelsafyan/Code/github/michaelsafyan/open-telemetry.opentelemetry-python-contrib/.tox/shellcheck
shellcheck: commands_pre[0]> sh -c 'sudo apt update -y && sudo apt install --assume-yes shellcheck'
[sudo] password for michaelsafyan:
It looks like it is attempting to install shellcheck. I already have this installed on my system:
$ shellcheck --version
ShellCheck - shell script analysis tool
version: 0.10.0
license: GNU General Public License, version 3
website: https://www.shellcheck.net
But it would be even better, if there are external dependencies like this, to use a container with podman (or to use something like nix-shell) to ensure that the version of the tool is repeatable. At the very least, though, this step should be skipped if the tool is already installed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the tox configuration that defines the shellcheck environment and reproduce the reported tox run. Check how the shellcheck dependency is detected or installed; done means an existing shellcheck installation does not trigger sudo, with the dependency behavior documented or tested.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, shell
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100