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

Package docs build workflow: use relaxed or tested requirements #2271

Open
wants to merge 3 commits into
base: devel
Choose a base branch
from

Conversation

oraNod
Copy link
Contributor

@oraNod oraNod commented Dec 9, 2024

Fixes #2270

This change updates the build package docs workflow to use either relaxed or tested requirements files.

I've pushed an additional commit to consolidate the two steps but I'm not sure if it's a good idea. On the one hand, it's tidier in the workflow file but maybe less obvious which set of requirements get installed when looking at the run.

@oraNod oraNod marked this pull request as ready for review December 9, 2024 21:00
@oraNod oraNod added doc builds Relates to building the documentation tooling This PR affects tooling (CI, pr_labeler, noxfile, linters, etc.) but not the docs builds themselves. labels Dec 9, 2024
This change updates the build package docs workflow to use either
relaxed or tested requirements files.
@oraNod oraNod force-pushed the issue-2270/relaxed-reqs branch from e4e6e55 to b5695da Compare December 9, 2024 21:08
@gotmax23
Copy link
Collaborator

Honestly, I wonder if we should just remove the relaxed dependencies file. I never end up using it. If I need to test a requirement change locally, I just edit the main constraints file and re-run pip-compile.

@oraNod
Copy link
Contributor Author

oraNod commented Dec 17, 2024

Honestly, I wonder if we should just remove the relaxed dependencies file. I never end up using it. If I need to test a requirement change locally, I just edit the main constraints file and re-run pip-compile.

Removing does mean one less thing to deal with. I'm fine with it personally but would like to hear what @felixfontein has to say. The whole point is to give him (and you) a set of dependencies to hack around with for dev purposes, as I'm sure you know.

@felixfontein
Copy link
Collaborator

Wasn't the purpose of the relaxed dependencies to use them for some docsite build (ansible-core devel or ansible devel), so that we'd have an "early warning" in case something breaks?

(I don't use the relaxed deps either.)

@oraNod
Copy link
Contributor Author

oraNod commented Dec 18, 2024

Wasn't the purpose of the relaxed dependencies to use them for some docsite build (ansible-core devel or ansible devel), so that we'd have an "early warning" in case something breaks?

(I don't use the relaxed deps either.)

Thanks @felixfontein

From what I recall the relaxed dependencies were intended as a replacement for that one docs/docsite/requirements.txt file so folks could plug in different dependencies and play around with builds without tampering with the "tested" requirements. There aren't any jobs - in jenkins or elsewhere - building with the relaxed requirements either. So if nobody is using them it probably would make sense to drop them altogether.

Should we close this PR?

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 tooling This PR affects tooling (CI, pr_labeler, noxfile, linters, etc.) but not the docs builds themselves.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Package docs build workflow needs to use relaxed reqs
3 participants