◐ Shell
reader mode source ↗
Skip to content

Convert doc.yml workflow to be reusable#103914

Merged
pradyunsg merged 2 commits into
python:mainfrom
webknjaz:maintenance/gha-reusable-docs-workflow
May 28, 2023
Merged

Convert doc.yml workflow to be reusable#103914
pradyunsg merged 2 commits into
python:mainfrom
webknjaz:maintenance/gha-reusable-docs-workflow

Conversation

@webknjaz

@webknjaz webknjaz commented Apr 27, 2023

Copy link
Copy Markdown
Member

This patch is meant to simplify the maintenance of multiple complex workflow definitions that are tied together into a single workflow later on.

It is separated out of #97533 for atomicity.

@bedevere-bot bedevere-bot added the label Apr 27, 2023
@webknjaz webknjaz mentioned this pull request Apr 27, 2023
Merged
webknjaz
webknjaz commented Apr 27, 2023
View reviewed changes

@webknjaz webknjaz left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Hide comment

@ambv I've added a few annotations below, hopefully they're helpful

@webknjaz webknjaz force-pushed the maintenance/gha-reusable-docs-workflow branch 3 times, most recently from cbf7985 to 3f8d6d2 Compare April 27, 2023 22:23
hugovk
hugovk previously requested changes Apr 30, 2023
View reviewed changes
@bedevere-bot

bedevere-bot commented Apr 30, 2023

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@ghost

ghost commented May 2, 2023 •
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

@webknjaz webknjaz requested a review from hugovk May 2, 2023 15:47
@webknjaz

webknjaz commented May 2, 2023

Copy link
Copy Markdown
Member Author

I have made the requested changes; please review again.

cc @ambv @hugovk

@bedevere-bot

bedevere-bot commented May 2, 2023

Copy link
Copy Markdown

Thanks for making the requested changes!

@hugovk: please review the changes made to this pull request.

@hugovk

hugovk commented May 10, 2023

Copy link
Copy Markdown
Member

How far back do we want to backport this (and its parent #97533), if at all?

@webknjaz

webknjaz commented May 10, 2023

Copy link
Copy Markdown
Member Author

@hugovk are there huge differences? I think it's okay to backport all the way back to 3.7, if the difference isn't big. Even if it is, I'm willing to explore solving all the cherry-picking conflicts, if necessary.

@webknjaz

webknjaz commented May 10, 2023

Copy link
Copy Markdown
Member Author

As for the "parent PR" I envision that @ambv would want it fully backported because he wanted to make auto-merge painless...

@hugovk

hugovk commented May 11, 2023

Copy link
Copy Markdown
Member

The general policy is to only backport non-security things for bugfix branches (i.e. 3.11), but CI changes can usually go further back because we need to test older security branches (i.e. 3.7-3.10) when we do get security fixes, and keeping them in sync makes backporting easier.

https://devguide.python.org/versions/

So we're probably fine backporting to 3.7, and we can always check with the release managers.

@webknjaz

webknjaz commented May 11, 2023

Copy link
Copy Markdown
Member Author

Yep, that was my thinking too.

@webknjaz

webknjaz commented May 24, 2023

Copy link
Copy Markdown
Member Author

I've implemented a similar change in pypa/build recently, it seems to work well so far: pypa/build@04df94c.

@webknjaz webknjaz force-pushed the maintenance/gha-reusable-docs-workflow branch 2 times, most recently from 1c7f95d to 0a04207 Compare May 24, 2023 16:50
@hugovk hugovk dismissed their stale review May 24, 2023 18:03

Changes made

37 hidden items Load more…
@webknjaz

webknjaz commented May 31, 2023

Copy link
Copy Markdown
Member Author

@hugovk this should fix the problem: #105151.

hugovk pushed a commit to hugovk/cpython that referenced this pull request Jun 1, 2023
@webknjaz @hugovk
Use CSV-separated outputs @ get-changed-files @ CI …
42980bf 
This is necessary because paths with whitespaces tend to crash said
action[[1]][[2]][[3]]. Also, we don't need to use JSON as it's harder
to parse while the value isn't used except for the emptiness check.

The change fixes [[4]]

[1]: https://github.com/Ana06/get-changed-files#get-all-changed-files-as-space-delimited
[2]: python#103914 (comment)
[3]: python#103914 (comment)
[4]: python#103914 (comment)
hugovk pushed a commit to hugovk/cpython that referenced this pull request Jun 1, 2023
@webknjaz @hugovk
Use CSV-separated outputs @ get-changed-files @ CI …
a589654 
This is necessary because paths with whitespaces tend to crash said
action[[1]][[2]][[3]]. Also, we don't need to use JSON as it's harder
to parse while the value isn't used except for the emptiness check.

The change fixes [[4]]

[1]: https://github.com/Ana06/get-changed-files#get-all-changed-files-as-space-delimited
[2]: python#103914 (comment)
[3]: python#103914 (comment)
[4]: python#103914 (comment)
@miss-islington

miss-islington commented Jul 22, 2023

Copy link
Copy Markdown
Contributor

Thanks @webknjaz for the PR, and @pradyunsg for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington

miss-islington commented Jul 22, 2023

Copy link
Copy Markdown
Contributor

Thanks @webknjaz for the PR, and @pradyunsg for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@miss-islington

miss-islington commented Jul 22, 2023

Copy link
Copy Markdown
Contributor

Sorry, @webknjaz and @pradyunsg, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 88d14da76f579fe014cbd7c15e42be4234135fe9 3.11

@miss-islington

miss-islington commented Jul 22, 2023

Copy link
Copy Markdown
Contributor

Sorry @webknjaz and @pradyunsg, I had trouble checking out the 3.12 backport branch.
Please retry by removing and re-adding the "needs backport to 3.12" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 88d14da76f579fe014cbd7c15e42be4234135fe9 3.12

@pablogsal pablogsal added the needs backport to 3.10 only security fixes label Jul 22, 2023
@miss-islington

miss-islington commented Jul 22, 2023

Copy link
Copy Markdown
Contributor

Thanks @webknjaz for the PR, and @pradyunsg for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

@miss-islington

miss-islington commented Jul 22, 2023

Copy link
Copy Markdown
Contributor

Sorry, @webknjaz and @pradyunsg, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 88d14da76f579fe014cbd7c15e42be4234135fe9 3.10

@miss-islington

miss-islington commented Jul 22, 2023

Copy link
Copy Markdown
Contributor

Thanks @webknjaz for the PR, and @pradyunsg for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington

miss-islington commented Jul 22, 2023

Copy link
Copy Markdown
Contributor

Sorry @webknjaz and @pradyunsg, I had trouble checking out the 3.8 backport branch.
Please retry by removing and re-adding the "needs backport to 3.8" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 88d14da76f579fe014cbd7c15e42be4234135fe9 3.8

@miss-islington

miss-islington commented Jul 22, 2023

Copy link
Copy Markdown
Contributor

Thanks @webknjaz for the PR, and @pradyunsg for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

@miss-islington

miss-islington commented Jul 22, 2023

Copy link
Copy Markdown
Contributor

Sorry, @webknjaz and @pradyunsg, I could not cleanly backport this to 3.9 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 88d14da76f579fe014cbd7c15e42be4234135fe9 3.9

webknjaz added a commit to webknjaz/cpython that referenced this pull request Jul 22, 2023
@webknjaz
[3.12] Convert doc.yml workflow to be reusable (pythonGH-103914) …
a0ab2e4 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
(cherry picked from commit 88d14da)

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
@bedevere-bot

bedevere-bot commented Jul 22, 2023

Copy link
Copy Markdown

GH-107042 is a backport of this pull request to the 3.12 branch.

@bedevere-bot

bedevere-bot commented Jul 22, 2023

Copy link
Copy Markdown

GH-107043 is a backport of this pull request to the 3.11 branch.

ambv pushed a commit that referenced this pull request Jul 23, 2023
@webknjaz
[3.11] Convert doc.yml workflow to be reusable (GH-103914 + GH-105151… …
561029a 
…) (#107043)

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>.

(cherry picked from commit 88d14da)
(cherry picked from commit eaa6702)
ambv pushed a commit that referenced this pull request Jul 23, 2023
@webknjaz
[3.12] Convert doc.yml workflow to be reusable (GH-103914 + GH-105151… …
1703262 
…) (#107042)

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

(cherry picked from commit 88d14da)
(cherry picked from commit eaa6702)
@webknjaz webknjaz mentioned this pull request Apr 24, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

@pradyunsg pradyunsg pradyunsg approved these changes

@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti ezio-melotti is a code owner

Assignees

@pradyunsg pradyunsg

Labels

skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@webknjaz @bedevere-bot @hugovk @encukou @miss-islington @pradyunsg @pablogsal @AlexWaygood