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

[stable-2.15] Backport workflow automation #342

Merged
merged 14 commits into from
Sep 5, 2023

Conversation

gotmax23
Copy link
Collaborator

Summary

This PR backports the workflow automation from the devel branch. It includes:

  • A noxfile to run python linters and formatters and refresh dependencies using pip-compile
  • A CI job to run those linters and formatters
  • A requirements-relaxed file for locally testing new antsibull-docs and sphinx versions.

Included PRs

This backport includes commits from the following PRs:

Initial workflow automation: nox and automated pip-compile #258

See the PR's description for more information.

The commits that add the pip-compile workflow are omitted. The workflow is not needed on stable-* branches. It can be triggered manually by going to https://github.com/ansible/ansible-documentation/actions/workflows/pip-compile-docs.yml, clicking Run workflow, and setting base-branch to stable-2.15.

Create requirements-relaxed file #271

The entirety of this PR is backported. See the PR's description for more information.

Limit sphinx to < 7.2.0 in requirements-relaxed #329

The entirety of this PR is backported. See the PR's description for more information.

ci: refresh docs build dependencies #316

This is an automated github-actions dependency refresh PR. Only the changed to the requirements-relaxed lockfile are included. The requirements-relaxed dependencies are not used in production.

gotmax23 and others added 13 commits August 27, 2023 20:01
This moves around the requirements a little bit so newer antsibull-docs
and sphinx versions can be tested independently of production ansible
documentation builds.

rstcheck and resolvelib constraints were moved out of constraints.in.
This file will only be used for strict pins that we want to manually update
separately from the rest of the dependencies.

(cherry picked from commit c139877)

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Don Naro <dnaro@redhat.com>
(cherry picked from commit 9e3af41)
(cherry picked from commit 886dfe3)

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Currently, this only lints the noxfile itself and the issue labeler
script.
We can expand the noxfile to build docs and lint other new files in
hacking.

(cherry picked from commit 40285f8)

Relates: ansible#54
This is copied from antsibull.

(cherry picked from commit 059db40)
(cherry picked from commit 2f5f79e)
(cherry picked from commit ae24c09)

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
This allows running the tests on an adhoc basis.

(cherry picked from commit 70775c5)
(cherry picked from commit c074d63)

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
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
This is based on
ansible#316 but only
changes requirements-relaxed.txt.

(cherry picked from commit e1e8657)
(cherry picked from commit 4ec04d6)

Co-authored-by: Github Actions <41898282+github-actions[bot]@users.noreply.github.com>
(cherry picked from commit 036d898)

Co-authored-by: Github Actions <41898282+github-actions[bot]@users.noreply.github.com>
@gotmax23 gotmax23 added doc builds Relates to building the documentation no_backport This PR should not be backported. devel only. labels Aug 27, 2023
@github-actions github-actions bot added the needs_triage Needs a first human triage before being processed. label Aug 27, 2023
@gotmax23 gotmax23 marked this pull request as ready for review August 29, 2023 15:40
@gotmax23
Copy link
Collaborator Author

gotmax23 commented Sep 3, 2023

This should be ready for review.

`nox -e lint` runs the `static` and `formatters` sessions, but it does
not run `nox -e typing` do to an oversight in the initial PR.
@oraNod oraNod removed the needs_triage Needs a first human triage before being processed. label Sep 5, 2023
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.

LGTM. Thank you @gotmax23

@oraNod oraNod merged commit 5ea593a into ansible:stable-2.15 Sep 5, 2023
6 checks passed
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 no_backport This PR should not be backported. devel only.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants