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.

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

[v1.13] doc: Migrate to .readthedocs.yaml v2 configuration and upgrade from Python 3.7 to 3.11 #27570

Merged
merged 2 commits into from Aug 21, 2023
Merged

[v1.13] doc: Migrate to .readthedocs.yaml v2 configuration and upgrade from Python 3.7 to 3.11 #27570

merged 2 commits into from Aug 21, 2023

Conversation

doniacld
Copy link
Contributor

Migrate to .readthedocs.yaml configuration file v2 before it becomes necessary to render documentation and upgrade Python from 3.7 to 3.11.

Backport commits from #27532

Fixes: #26299

doc: Migrate to .readthedocs.yaml configuration file v2

@doniacld
doc: Migrate readthedocs.yaml configuration v2
c9b680f 
Read the Docs will start requires a .readthedeocs.yaml configiration file in
order to build documentation successfully. For more information visit
https://blog.readthedocs.com/migrate-configuration-v2/
This commit also upgrade Python version from 3.7 to 3.11

Signed-off-by: Donia Chaiehloudj <donia.cld@isovalent.com>
@doniacld
ci(doc): Bump docs-builder image version
0dbec5b 
Signed-off-by: Donia Chaiehloudj <donia.cld@isovalent.com>
@doniacld doniacld requested review from a team as code owners August 17, 2023 12:59
@doniacld doniacld temporarily deployed to docs-builder August 17, 2023 12:59 — with GitHub Actions Inactive
@doniacld doniacld requested a review from a team as a code owner August 17, 2023 12:59
@doniacld doniacld temporarily deployed to release-base-images August 17, 2023 12:59 — with GitHub Actions Inactive
@doniacld doniacld requested review from a team as code owners August 17, 2023 12:59
@doniacld doniacld requested review from a team and removed request for jrajahalme, joamaki, brb, julianwiedmann, lmb, christarazi, kaworu and rolinh August 17, 2023 13:00
@doniacld doniacld added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. kind/backports This PR provides functionality previously merged into master. backport/1.13 This PR represents a backport for Cilium 1.13.x of a PR that was merged to main. and removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Aug 17, 2023
qmonnet
qmonnet approved these changes Aug 17, 2023
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Change looks good and is similar to the other backports, although we can't verify whether the documentation workflow passes. I don't know what the current failure with the image builds is related to.

@nbusseneau nbusseneau closed this Aug 17, 2023
@nbusseneau nbusseneau reopened this Aug 17, 2023
@nbusseneau
Copy link
Member

nbusseneau commented Aug 17, 2023 •
edited

Change looks good and is similar to the other backports, although we can't verify whether the documentation workflow passes. I don't know what the current failure with the image builds is related to.

I think changing the target branch of the PR confused GH, it was trying to run the CI off the wrong SHA. Forcing a refresh via the close/reopen trick seems to have worked, now the documentation workflow should run.

EDIT: yep, workflow passed.

@doniacld
Copy link
Contributor Author

Change looks good and is similar to the other backports, although we can't verify whether the documentation workflow passes. I don't know what the current failure with the image builds is related to.

I think changing the target branch of the PR confused GH, it was trying to run the CI off the wrong SHA. Forcing a refresh via the close/reopen trick seems to have worked, now the documentation workflow should run.

EDIT: yep, workflow passed.

Thanks! Sorry for the error! Clicked to fast on open the PR!..

@doniacld
Copy link
Contributor Author

/test

@aanm
Copy link
Member

aanm commented Aug 21, 2023

/test-backport-1.13

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Aug 21, 2023
@joestringer joestringer merged commit 235dcde into cilium:v1.13 Aug 21, 2023
66 of 76 checks passed
@joestringer joestringer mentioned this pull request Aug 21, 2023
Closed
@joestringer
Copy link
Member

@doniacld heads up, since I'm not sure if someone communicated this already: We use different test trigger phrases for different branches. That's why some of the tests failed, because you had previously triggered the main branch tests for the v1.13 branch using /test, instead of running the v1.13 branch tests using /test-backport-1.13. You can see the full list of trigger phrases here:

https://docs.cilium.io/en/stable/contributing/testing/ci/#triggering-platform-tests

@doniacld
Copy link
Contributor Author

@doniacld heads up, since I'm not sure if someone communicated this already: We use different test trigger phrases for different branches. That's why some of the tests failed, because you had previously triggered the main branch tests for the v1.13 branch using /test, instead of running the v1.13 branch tests using /test-backport-1.13. You can see the full list of trigger phrases here:

https://docs.cilium.io/en/stable/contributing/testing/ci/#triggering-platform-tests

Thx a lot for your link! 👍 Now I feel equipped.

@doniacld doniacld mentioned this pull request Aug 24, 2023
Merged
8 tasks
@michi-covalent michi-covalent mentioned this pull request Sep 9, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ti-mo ti-mo ti-mo approved these changes

@nbusseneau nbusseneau nbusseneau approved these changes

@qmonnet qmonnet qmonnet approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport/1.13 This PR represents a backport for Cilium 1.13.x of a PR that was merged to main. kind/backports This PR provides functionality previously merged into master. ready-to-merge This PR has passed all tests and received consensus from code owners to merge.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Migrate to .readthedocs.yaml configuration file v2
6 participants
@doniacld @nbusseneau @aanm @joestringer @ti-mo @qmonnet