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

limit sphinx to < 7.2.0 in requirements-relaxed #329

Merged
merged 1 commit into from
Aug 24, 2023

Conversation

gotmax23
Copy link
Collaborator

@gotmax23 gotmax23 commented Aug 23, 2023

limit sphinx to < 7.2.0 in requirements-relaxed

7.2.0 breaks sphinx-notfound-page. This commit sets a general constraint
that applies to the testing requirements (requirements-relaxed).

Relates: #327

@gotmax23 gotmax23 added the doc builds Relates to building the documentation label Aug 23, 2023
@gotmax23 gotmax23 requested a review from oraNod August 23, 2023 17:58
@github-actions github-actions bot added the needs_triage Needs a first human triage before being processed. label Aug 23, 2023
@gotmax23
Copy link
Collaborator Author

Rebased to fix commit message

Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

just putting a hold so we can decide which PR to go forward with, this or #320

and then test/verify the results of a jenkins build

@gotmax23
Copy link
Collaborator Author

just putting a hold so we can decide which PR to go forward with, this or #320

These PRs address separate issues. This PR sets a general constraint that applies to the testing requirements (requirements-relaxed). Adding an exact pin for the sphinx version is a separate issue and handled by @oraNod's PR. The two PRs are additive, not mutually exclusive.

and then test/verify the results of a jenkins build

Yeah, even though the relaxed requirements file is not used for production docs builds, it'd still be a good idea to make sure the build works on testing.

@samccann
Copy link
Contributor

Ok thanks. Is there an order in which these PRs should merge or does it not matter?

7.2.0 breaks sphinx-notfound-page. This commit sets a general constraint
that applies to the testing requirements (requirements-relaxed).

Relates: ansible#327
@gotmax23
Copy link
Collaborator Author

Ok thanks. Is there an order in which these PRs should merge or does it not matter?

It doesn't matter, but I would merge this one first. I changed it a bit so all it does is set a general constraint and not update lock files at all. Therefore, it shouldn't affect docs builds at all, as they have a specific sphinx version pinned.

I also added some PR body text. Thanks for the suggestion.

Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

LGTM. Let's wait for two approvals before merging

@samccann samccann removed the needs_triage Needs a first human triage before being processed. label Aug 23, 2023
@oraNod oraNod merged commit c07047f into ansible:devel Aug 24, 2023
6 checks passed
@oraNod
Copy link
Contributor

oraNod commented Aug 24, 2023

Thanks @gotmax23 and all

gotmax23 added a commit to gotmax23/ansible-documentation that referenced this pull request Aug 27, 2023
7.2.0 breaks sphinx-notfound-page. This commit sets a general constraint
that applies to the testing requirements (requirements-relaxed).

(cherry picked from commit c07047f)

Relates: ansible#327
gotmax23 added a commit to gotmax23/ansible-documentation that referenced this pull request Sep 9, 2023
Reverts "limit sphinx to `< 7.2.0` in requirements-relaxed (ansible#329)"

The new version of sphinx-not-found-page restores compatibility with
newer sphinx versions, so we no longer need to limit it.
Note that this only affects the requirements-relaxed file used for local
testing.
Production builds still use `sphinx==6.2.1`

Ref: ansible#351 (comment)
gotmax23 added a commit to gotmax23/ansible-documentation that referenced this pull request Sep 11, 2023
Reverts "limit sphinx to `< 7.2.0` in requirements-relaxed (ansible#329)"

The new version of sphinx-not-found-page restores compatibility with
newer sphinx versions, so we no longer need to limit it.
Note that this only affects the requirements-relaxed file used for local
testing.
Production builds still use `sphinx==6.2.1`

Ref: ansible#351 (comment)
gotmax23 added a commit to gotmax23/ansible-documentation that referenced this pull request Sep 11, 2023
Reverts "limit sphinx to `< 7.2.0` in requirements-relaxed (ansible#329)"

The new version of sphinx-not-found-page restores compatibility with
newer sphinx versions, so we no longer need to limit it in
constraints-base.in

The production `requirements.txt` file will be constrained to `sphinx ==
7.2.5` until we manually change the pin in constraints.in.

The requirements-relaxed.txt file for local testing will continue
updating to the latest sphinx version in the weekly requirements update
PRs.

Ref: ansible#351 (comment)
oraNod pushed a commit that referenced this pull request Sep 13, 2023
Reverts "limit sphinx to `< 7.2.0` in requirements-relaxed (#329)"

The new version of sphinx-not-found-page restores compatibility with
newer sphinx versions, so we no longer need to limit it in
constraints-base.in

The production `requirements.txt` file will be constrained to `sphinx ==
7.2.5` until we manually change the pin in constraints.in.

The requirements-relaxed.txt file for local testing will continue
updating to the latest sphinx version in the weekly requirements update
PRs.

Ref: #351 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc builds Relates to building the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants