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

Add ruff, adjust pyugprade, autoflake in docs #19555

Merged
merged 3 commits into from
Aug 8, 2023

Conversation

huonw
Copy link
Contributor

@huonw huonw commented Aug 6, 2023

Fixes #19273 by adding ruff to the docs, both the auto-generated backend docs and the manual pages that list out backends. This doesn't try to solve the general problem of reminding us to add backends to docs.

While I was there, I noticed the pyupgrade and autoflake backends were referring to the experimental paths, but they've now graduated to non-experimental, so this switches them over.

@huonw huonw merged commit 9b1b322 into pantsbuild:main Aug 8, 2023
25 checks passed
@huonw huonw deleted the bugfix/19273-docs branch August 8, 2023 22:33
@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.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 fetch https://github.com/pantsbuild/pants main \
      && git fetch https://github.com/pantsbuild/pants 2.16.x \
      && git checkout -b cherry-pick-19555-to-2.16.x FETCH_HEAD \
      && git cherry-pick 9b1b322701347a7e260e25e90a859360e1750a5d
  3. Fix the merge conflicts and commit the changes
  4. Run build-support/cherry_pick/make_pr.sh "19555" "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 fetch https://github.com/pantsbuild/pants main \
      && git fetch https://github.com/pantsbuild/pants 2.17.x \
      && git checkout -b cherry-pick-19555-to-2.17.x FETCH_HEAD \
      && git cherry-pick 9b1b322701347a7e260e25e90a859360e1750a5d
  3. Fix the merge conflicts and commit the changes
  4. Run build-support/cherry_pick/make_pr.sh "19555" "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 Aug 8, 2023
huonw added a commit to huonw/pants that referenced this pull request Aug 8, 2023
Fixes pantsbuild#19273 by adding ruff to the docs, both the auto-generated backend
docs and the manual pages that list out backends. This doesn't try to
solve the general problem of reminding us to add backends to docs.

While I was there, I noticed the pyupgrade and autoflake backends were
referring to the `experimental` paths, but they've now graduated to
non-experimental, so this switches them over.
huonw added a commit to huonw/pants that referenced this pull request Aug 8, 2023
Fixes pantsbuild#19273 by adding ruff to the docs, both the auto-generated backend
docs and the manual pages that list out backends. This doesn't try to
solve the general problem of reminding us to add backends to docs.

While I was there, I noticed the pyupgrade and autoflake backends were
referring to the `experimental` paths, but they've now graduated to
non-experimental, so this switches them over.
thejcannon pushed a commit that referenced this pull request Aug 9, 2023
…#19576)

Fixes #19273 by adding ruff to the docs, both the auto-generated backend
docs and the manual pages that list out backends. This doesn't try to
solve the general problem of reminding us to add backends to docs.

While I was there, I noticed the pyupgrade and autoflake backends were
referring to the `experimental` paths, but they've now graduated to
non-experimental, so this switches them over.
huonw added a commit that referenced this pull request Aug 9, 2023
…#19577)

Fixes #19273 by adding ruff to the docs, both the auto-generated backend
docs and the manual pages that list out backends. This doesn't try to
solve the general problem of reminding us to add backends to docs.

While I was there, I noticed the pyupgrade and autoflake backends were
referring to the `experimental` paths, but they've now graduated to
non-experimental, so this switches them over.
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.

ruff backend missing from 2.16.x docs
3 participants