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

docs: layout tweak of caching info, remove toolchain :( and additional info about bazel-remote-cache #19299

Merged
merged 2 commits into from
Jun 15, 2023

Conversation

mike-geeves-oxb
Copy link
Contributor

Minor doc improvements

Copy link
Member

@WorkerPants WorkerPants left a comment

Choose a reason for hiding this comment

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

Welcome to the Pantsbuild Community. This looks like your first PR here.

We are so grateful for each an every contribution, big or small.
So thanks for spending your time and energy making this project better.

If you haven't gotten a reply in a week, feel free to gently comment "bump" to ping the project admins.

If you haven't already, feel free to come say hi on Slack.

If you have questions, or just want to surface this PR, check out the #development channel.
(If you want to check it out without logging in, check out our Linen mirror)

Thanks again for this PR, and we'll be on the lookout for your next one 😄!

@mike-geeves-oxb mike-geeves-oxb marked this pull request as ready for review June 12, 2023 19:12
Copy link
Contributor

@benjyw benjyw left a comment

Choose a reason for hiding this comment

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

Just punctuation nits. Thanks!

docs/markdown/Using Pants/remote-caching-execution.md Outdated Show resolved Hide resolved
docs/markdown/Using Pants/remote-caching-execution.md Outdated Show resolved Hide resolved
chore: apply suggestions, adding in missing .

Co-authored-by: Benjy Weinberger <[email protected]>
@mike-geeves-oxb mike-geeves-oxb requested a review from benjyw June 14, 2023 09:59
Copy link
Contributor

@benjyw benjyw left a comment

Choose a reason for hiding this comment

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

Thanks for this fix! I will cherry-pick it to relevant docs versions.

@benjyw benjyw added this to the 2.15.x milestone Jun 15, 2023
@benjyw benjyw merged commit 21f377d into pantsbuild:main Jun 15, 2023
github-actions bot pushed a commit that referenced this pull request Jun 15, 2023
…l info about bazel-remote-cache (#19299)

Minor doc improvements.
github-actions bot pushed a commit that referenced this pull request Jun 15, 2023
…l info about bazel-remote-cache (#19299)

Minor doc improvements.
github-actions bot pushed a commit that referenced this pull request Jun 15, 2023
…l info about bazel-remote-cache (#19299)

Minor doc improvements.
@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.15.x

I was unable to cherry-pick this PR to 2.15.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 checkout https://github.com/pantsbuild/pants main \
      && git pull \
      && git fetch https://github.com/pantsbuild/pants 2.15.x \
      && git checkout -b cherry-pick-19299-to-2.15.x FETCH_HEAD \
      && git cherry-pick 21f377deeaae9fdc30ebb60ccc1851b37844d308
  3. Fix the merge conflicts and commit the changes
  4. Run build-support/cherry_pick/make_pr.sh -- "19299" "2.15.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.16.x

I was unable to cherry-pick this PR to 2.16.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 checkout https://github.com/pantsbuild/pants main \
      && git pull \
      && git fetch https://github.com/pantsbuild/pants 2.16.x \
      && git checkout -b cherry-pick-19299-to-2.16.x FETCH_HEAD \
      && git cherry-pick 21f377deeaae9fdc30ebb60ccc1851b37844d308
  3. Fix the merge conflicts and commit the changes
  4. Run build-support/cherry_pick/make_pr.sh -- "19299" "2.16.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.17.x

I was unable to cherry-pick this PR to 2.17.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 checkout https://github.com/pantsbuild/pants main \
      && git pull \
      && git fetch https://github.com/pantsbuild/pants 2.17.x \
      && git checkout -b cherry-pick-19299-to-2.17.x FETCH_HEAD \
      && git cherry-pick 21f377deeaae9fdc30ebb60ccc1851b37844d308
  3. Fix the merge conflicts and commit the changes
  4. Run build-support/cherry_pick/make_pr.sh -- "19299" "2.17.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.


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 Jun 15, 2023
@thejcannon
Copy link
Member

There wasn't actually a merge-conflict, the GHA code should've been ported by to the older branches.

See: #19322

If you want, once these are fixed (after https://pantsbuild.slack.com/archives/C0D7TNJHL/p1686790197387729 is fixed) we can kick the bot to run on this PR.

@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.15.x

I was unable to cherry-pick this PR to 2.15.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 checkout https://github.com/pantsbuild/pants main \
      && git pull \
      && git fetch https://github.com/pantsbuild/pants 2.15.x \
      && git checkout -b cherry-pick-19299-to-2.15.x FETCH_HEAD \
      && git cherry-pick 21f377deeaae9fdc30ebb60ccc1851b37844d308
  3. Fix the merge conflicts and commit the changes
  4. Run build-support/cherry_pick/make_pr.sh -- "19299" "2.15.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.16.x

I was unable to cherry-pick this PR to 2.16.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 checkout https://github.com/pantsbuild/pants main \
      && git pull \
      && git fetch https://github.com/pantsbuild/pants 2.16.x \
      && git checkout -b cherry-pick-19299-to-2.16.x FETCH_HEAD \
      && git cherry-pick 21f377deeaae9fdc30ebb60ccc1851b37844d308
  3. Fix the merge conflicts and commit the changes
  4. Run build-support/cherry_pick/make_pr.sh -- "19299" "2.16.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.17.x

I was unable to cherry-pick this PR to 2.17.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 checkout https://github.com/pantsbuild/pants main \
      && git pull \
      && git fetch https://github.com/pantsbuild/pants 2.17.x \
      && git checkout -b cherry-pick-19299-to-2.17.x FETCH_HEAD \
      && git cherry-pick 21f377deeaae9fdc30ebb60ccc1851b37844d308
  3. Fix the merge conflicts and commit the changes
  4. Run build-support/cherry_pick/make_pr.sh -- "19299" "2.17.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.


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

@thejcannon
Copy link
Member

Ok that failure was on me. One more before I turn on the seatbelt buckle sign.

Hold on...

github-actions bot pushed a commit that referenced this pull request Jun 15, 2023
…l info about bazel-remote-cache (#19299)

Minor doc improvements.
github-actions bot pushed a commit that referenced this pull request Jun 15, 2023
…l info about bazel-remote-cache (#19299)

Minor doc improvements.
github-actions bot pushed a commit that referenced this pull request Jun 15, 2023
…l info about bazel-remote-cache (#19299)

Minor doc improvements.
@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.15.x

Successfully opened #19330.

✔️ 2.16.x

Successfully opened #19331.

✔️ 2.17.x

Successfully opened #19329.


Thanks again for your contributions!

🤖 Beep Boop here's my run link

@thejcannon
Copy link
Member

TADA 🎉

@mike-geeves-oxb
Copy link
Contributor Author

Thanks!
Phew, much effort for a tiny commit 😅 I'll try and do a little bigger next time!

@thejcannon
Copy link
Member

Haha, you just happened to be merging at the time where we're investing more in automation. And GHA isn't the easiest thing to get right 😅

@mike-geeves-oxb
Copy link
Contributor Author

Well, it's a nicer process than the "suggest edits" before so worth it imo 👍 (having tried both at the same time for this one!)

As long as you're not quite at https://xkcd.com/1319

@thejcannon
Copy link
Member

Only time will tell, honestly. I chalk up time spent to "learning". I found some interesting and novel ways of testing our GitHub Actions. I also started getting comfortable with https://github.com/actions/github-script and the GitHub Rest API

benjyw pushed a commit that referenced this pull request Jun 16, 2023
…l info about bazel-remote-cache (Cherry-pick of #19299) (#19329)

Minor doc improvements

Co-authored-by: Mike Geeves <[email protected]>
benjyw pushed a commit that referenced this pull request Jun 16, 2023
…l info about bazel-remote-cache (Cherry-pick of #19299) (#19330)

Minor doc improvements

Co-authored-by: Mike Geeves <[email protected]>
benjyw pushed a commit that referenced this pull request Jun 16, 2023
…l info about bazel-remote-cache (Cherry-pick of #19299) (#19331)

Minor doc improvements

Co-authored-by: Mike Geeves <[email protected]>
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.

4 participants