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

ci: refresh docs build dependencies #316

Merged
merged 1 commit into from
Aug 28, 2023
Merged

ci: refresh docs build dependencies #316

merged 1 commit into from
Aug 28, 2023

Conversation

github-actions[bot]
Copy link
Contributor

No description provided.

@github-actions github-actions bot added the dependency_update PR to update pinned dependencies label Aug 21, 2023
@gotmax23 gotmax23 requested review from samccann and oraNod August 21, 2023 18:50
@gotmax23
Copy link
Collaborator

Hmm, something weird is going on with CI for this pull request. The tasks don't seem to be starting. I got #315 to work by opening and closing the pull request. @webknjaz is this what you were referring to?

PR CI status

@webknjaz
Copy link
Member

Yes.

@webknjaz
Copy link
Member

FWIW a common workaround is to use https://github.com/marketplace/actions/github-app-token.

@gotmax23 gotmax23 closed this Aug 21, 2023
@gotmax23 gotmax23 reopened this Aug 21, 2023
@github-actions github-actions bot added the needs_triage Needs a first human triage before being processed. label Aug 21, 2023
@gotmax23
Copy link
Collaborator

I toggled the PR to trigger CI. We can come up with a better solution in the future.

Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

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

Hmm. I think this is OK but a little premature or something.

The logic of the docs build jobs on Jenkins (cannot wait to get community visibility into them) has been like this:

If devel, install requirements from docs/docsite/requirements.txt
If stable, install requirements from either tests or the good known reqs file (stable-2.14 only).

Now the relaxed requirements are in place, we can remove the docs/docsite/requirements.txt file. However we still need to bump the sphinx version in the lockfile to match what was previously on devel. I captured it in this issue: #267

I feel like we should do that first and will send a PR. I'd prefer to finish cleaning up a little before we merge this so it isn't such a big jump between sphinx versions.

I also feel like PRs that bump sphinx to a new major version should get built on test and have a defined soak time. @samccann Maybe we could come up with a sanity checklist of things to look for in the docs build?

@samccann
Copy link
Contributor

We can't merge this until the build works with sphinx 7.2.2

And yes, all changes to requirements must be fully tested and verified on a staged build to the test site.

@github-actions github-actions bot force-pushed the pip-compile/devel/docs branch from 5ccd223 to 76967e8 Compare August 24, 2023 08:44
@gotmax23 gotmax23 closed this Aug 24, 2023
@gotmax23 gotmax23 reopened this Aug 24, 2023
@github-actions github-actions bot force-pushed the pip-compile/devel/docs branch from 76967e8 to e1e8657 Compare August 26, 2023 16:20
@gotmax23 gotmax23 closed this Aug 26, 2023
@gotmax23 gotmax23 reopened this Aug 26, 2023
@gotmax23
Copy link
Collaborator

I'm removing the draft status. All this PR does is update the requiremented-relaxed file which are not used in production and only for local tests. I did a test coredocs build locally and confirmed that this works properly.

We can't merge this until the build works with sphinx 7.2.2

This now only bumps the sphinx version to 7.1.2.

@gotmax23 gotmax23 marked this pull request as ready for review August 27, 2023 19:45
Copy link
Collaborator

@gotmax23 gotmax23 left a comment

Choose a reason for hiding this comment

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

Ack.

gotmax23 pushed a commit to gotmax23/ansible-documentation that referenced this pull request Aug 27, 2023
This is based on
ansible#316 but only
changes requirements-relaxed.txt.

(cherry picked from commit e1e8657)
@oraNod oraNod merged commit 11da252 into devel Aug 28, 2023
@oraNod oraNod deleted the pip-compile/devel/docs branch August 28, 2023 15:58
@oraNod
Copy link
Contributor

oraNod commented Aug 28, 2023

Thank you @gotmax23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependency_update PR to update pinned dependencies needs_triage Needs a first human triage before being processed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants