Automattic / Automattic/jetpack
Build Tools: mark jq as required tool
- Dominant language
- PHP
- Stars
- 1.8k
- Forks
- 898
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 774
Description
`jq` is used for a lot of our scripts, including some of the scripts one must run even when contributing only once to the repo.
Instead of running into errors when running the scripts, let's bail early and provide a recommendation for installing the tool (`brew install jq`), just like we do for Bash
https://github.com/Automattic/jetpack/blob/9b224ade631ab384b3b5ddfdbc8586828cc74eaa/tools/includes/check-osx-bash-version.sh#L12-L15
*******
Reference: p1630016900007500-slack-C0299DMPG
Contributor guide
Research direction
Start by reading tools/includes/check-osx-bash-version.sh around lines 12–15, which is the reference for the existing Bash check. Trace the scripts that require jq, add an early failure with the brew install jq recommendation, and verify that contributors receive the message before those scripts produce errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100