pcdshub / pcdshub/engineering_tools
Revise hard-coded paths to the engineering_tools deploy directory from within engineering_tools
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 36
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 3
Description
Expected Behavior
All scripts in engineering_tools that need to run another script in engineering_tools should run the script in the same release directory, so that we can isolate version-specific behavior and test/deploy more easily.
Current Behavior
Some scripts reference the specific release directory directly:
https://github.com/pcdshub/engineering_tools/blob/953c167e0701756b8ff41da1362e1a2b2cb525e4/scripts/set_gem_timing#L31
Possible Solution
Use any of the various bash-isms for getting the current directory of a shell script.
Context
https://github.com/pcdshub/engineering_tools/pull/204#discussion_r1783235437
Contributor guide
No contributing guide indexed for this repository
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 with scripts/set_gem_timing at the referenced line and review the discussion in pull request 204. Identify the other engineering_tools scripts that invoke sibling scripts, then verify that each uses its own release directory; done means no such invocation relies on a hard-coded release path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash
- Domain
- cli
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100