Skip to content

Enforce backport conditions on v*-doc branches #21833

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jan 12, 2022
Merged

Enforce backport conditions on v*-doc branches #21833

merged 2 commits into from
Jan 12, 2022

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Dec 1, 2021 •
edited
Loading

PR Summary

The v*-doc backport branches build docs against the released version. This is not enforced in the CI, and PRs can be backported that have no effect (e.e.g, #21631).

This PR adds a check that lib files are not modified on backports, and also attempts to run CircleCI with the right version.

Also fixes the added-and-modified check which was incorrectly failing in #21799, as noted on gitter.

PR Checklist

Tests and Styling

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [n/a] New features are documented, with examples if plot related.
  • [n/a] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [n/a] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@QuLogic QuLogic added this to the v3.5-doc milestone Dec 1, 2021
@QuLogic
Copy link
Member Author

QuLogic commented Dec 2, 2021

I'll try to post a test PR for this before it gets merged.

@ojeda-e ojeda-e mentioned this pull request Dec 5, 2021
Merged
5 tasks
@QuLogic QuLogic force-pushed the clean-doc-backports branch from e5031a0 to f7b44fb Compare December 8, 2021 20:56
@QuLogic QuLogic force-pushed the clean-doc-backports branch from f7b44fb to dce55e2 Compare December 8, 2021 21:52
@QuLogic
Copy link
Member Author

QuLogic commented Dec 8, 2021

Here is a build on v3.5.0-doc showing that we are building against the release for the backport doc build.

Here is a pull request with an invalid backport.

@tacaswell tacaswell merged commit 6cebe46 into matplotlib:main Jan 12, 2022
@lumberbot-app
Copy link

lumberbot-app bot commented Jan 12, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.5.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -m1 6cebe46157976ab16cc8da38415e5fb15bcc4607
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #21833: Enforce backport conditions on v*-doc branches'
  1. Push to a named branch:
git push YOURFORK v3.5.x:auto-backport-of-pr-21833-on-v3.5.x
  1. Create a PR against branch v3.5.x, I would have named this PR:

"Backport PR #21833 on branch v3.5.x (Enforce backport conditions on v*-doc branches)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@lumberbot-app
Copy link

lumberbot-app bot commented Jan 12, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.5.1-doc
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -m1 6cebe46157976ab16cc8da38415e5fb15bcc4607
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #21833: Enforce backport conditions on v*-doc branches'
  1. Push to a named branch:
git push YOURFORK v3.5.1-doc:auto-backport-of-pr-21833-on-v3.5.1-doc
  1. Create a PR against branch v3.5.1-doc, I would have named this PR:

"Backport PR #21833 on branch v3.5.1-doc (Enforce backport conditions on v*-doc branches)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@QuLogic QuLogic deleted the clean-doc-backports branch January 12, 2022 21:04
tacaswell added a commit to tacaswell/matplotlib that referenced this pull request Jan 12, 2022
@tacaswell
Backport PR matplotlib#21833: Enforce backport conditions on v*-doc b…
01c9d4e 
…ranches

Merge pull request matplotlib#21833 from QuLogic/clean-doc-backports

CI: Enforce backport conditions on v*-doc branches
tacaswell added a commit to tacaswell/matplotlib that referenced this pull request Jan 12, 2022
@tacaswell
Backport PR matplotlib#21833: Enforce backport conditions on v*-doc b…
8ae93c1 
…ranches

Merge pull request matplotlib#21833 from QuLogic/clean-doc-backports

CI: Enforce backport conditions on v*-doc branches
This was referenced Jan 12, 2022
Merged
Merged
QuLogic added a commit that referenced this pull request Jan 12, 2022
@QuLogic
Merge pull request #22220 from tacaswell/auto-backport-of-pr-21833-on…
c454a96 
…-v3.5.x

Backport PR #21833: Enforce backport conditions on v*-doc branches
QuLogic added a commit that referenced this pull request Jan 19, 2022
@QuLogic
Merge pull request #22221 from tacaswell/auto-backport-of-pr-21833-on…
feb68c7 
…-v3.5.1-doc

Backport PR #21833: Enforce backport conditions on v*-doc branches
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tacaswell tacaswell tacaswell approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.5-doc
Development

Successfully merging this pull request may close these issues.
2 participants
@QuLogic @tacaswell