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

Tooling: Add support for bundled jq version in dev environment check #40897

Merged
merged 1 commit into from
Jan 8, 2025

Conversation

tbradsha
Copy link
Contributor

@tbradsha tbradsha commented Jan 8, 2025

As of macOS 10.15, jq is included. The version is 1.6-159-apple-gcff5336-dirty, which would be parsed as being less than 1.6, and thus fails dev environment checks. That said, the referenced commit is from 2022, so in reality it's newer than 1.6:

jqlang/jq@cff5336

I'm not even sure why the check requires 1.6 (it might be arbitrary), but this PR should at least let people proceed with the version they have.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

On a Mac without jq installed manually (or at least added in the path), run tools/check-development-environment.sh.

@tbradsha tbradsha self-assigned this Jan 8, 2025
Copy link
Contributor

github-actions bot commented Jan 8, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 8, 2025
@tbradsha tbradsha added the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jan 8, 2025
@tbradsha tbradsha requested a review from a team January 8, 2025 16:43
@tbradsha tbradsha removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 8, 2025
Copy link
Contributor

@kraftbj kraftbj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

➜ jq --version && ./tools/check-development-environment.sh
jq-1.6-159-apple-gcff5336-dirty
Jetpack development environment check
=====================================

Monorepo path: /Users/kraft/code/jetpack

Shell tools
===========

* Usable version of bash                   ... ok (version 5.2.37(1)-release)
* Standard tools are available             ... yes
* If sed accepts -E                        ... yes
* Usable version of jq                     ... ok (version 1.6-159-apple-gcff5336-dirty)

@kraftbj kraftbj added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Jan 8, 2025
@tbradsha tbradsha merged commit 1675c72 into trunk Jan 8, 2025
60 checks passed
@tbradsha tbradsha deleted the fix/tooling/bundled_jq_is_okay branch January 8, 2025 16:53
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Jan 8, 2025
@anomiex
Copy link
Contributor

anomiex commented Jan 8, 2025

I'm not even sure why the check requires 1.6 (it might be arbitrary)

Probably semi-arbitrary, in that it was the current version when 5f9ce13 added the version check.

I see 1.7 was released since. I wonder how long until we accidentally use a new-in-1.7 feature in a script that's used outside of CI. 😅

@tbradsha
Copy link
Contributor Author

tbradsha commented Jan 8, 2025

Yeah, and it somewhat pains me to add a specific check like the one in this script, but I think the benefits of not forcing a dependency install make it worth it for now.

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

Successfully merging this pull request may close these issues.

3 participants