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

update pants peek docs with latest outputs #22051

Merged
merged 1 commit into from
Mar 6, 2025

Conversation

tdyas
Copy link
Contributor

@tdyas tdyas commented Mar 6, 2025

Fix #20885 by updating the documentation for pants peek to reflect the current structure of the JSON output.

Closes #20885

@tdyas tdyas added needs-cherrypick category:internal CI, fixes for not-yet-released features, etc. release-notes:not-required PR doesn't require mention in release notes labels Mar 6, 2025
@tdyas tdyas added this to the 2.24.x milestone Mar 6, 2025
@tdyas tdyas requested review from huonw and thejcannon March 6, 2025 21:10
@tdyas tdyas merged commit 0ac89ee into pantsbuild:main Mar 6, 2025
24 checks passed
tdyas added a commit that referenced this pull request Mar 6, 2025
…22052)

Fix #20885 by updating the
documentation for `pants peek` to reflect the current structure of the
JSON output.

Closes #20885

Co-authored-by: Tom Dyas <[email protected]>
@WorkerPants
Copy link
Member

I tried to automatically cherry-pick this change back to each relevant milestone, so that it is available in those older releases of Pants.

❌ 2.24.x

I was unable to cherry-pick this PR to 2.24.x, likely due to merge-conflicts.

Steps to Cherry-Pick locally

To resolve:

  1. (Ensure your git working directory is clean)
  2. Run the following script to reproduce the merge-conflicts:
    git fetch https://github.com/pantsbuild/pants main \
      && git fetch https://github.com/pantsbuild/pants 2.24.x \
      && git checkout -b cherry-pick-22051-to-2.24.x FETCH_HEAD \
      && git cherry-pick 0ac89eed7a018ee0bcb7dac621d1dc3719eec06f
  3. Fix the merge conflicts and commit the changes
  4. Run build-support/cherry_pick/make_pr.sh "22051" "2.24.x"

Please note that I cannot re-run CI if a job fails. Please work with your PR approver(s) to re-run CI if necessary.

✔️ 2.25.x

Successfully opened #22053.


When you're done manually cherry-picking, please remove the needs-cherrypick label on this PR.

Thanks again for your contributions!

🤖 Beep Boop here's my run link

@WorkerPants WorkerPants added the auto-cherry-picking-failed Auto Cherry-Picking Failed label Mar 6, 2025
tdyas added a commit that referenced this pull request Mar 6, 2025
…22053)

Fix #20885 by updating the
documentation for `pants peek` to reflect the current structure of the
JSON output.

Closes #20885

Co-authored-by: Tom Dyas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-cherry-picking-failed Auto Cherry-Picking Failed category:internal CI, fixes for not-yet-released features, etc. needs-cherrypick release-notes:not-required PR doesn't require mention in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

peek documentation example output is outdated/incomplete
3 participants