Skip to content

Integrate docs/bin/*.py files into the nox config #529

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
Merged
gotmax23 merged 3 commits into from
Oct 11, 2023
Merged

Integrate docs/bin/*.py files into the nox config #529

gotmax23 merged 3 commits into from
Oct 11, 2023

Conversation

@gotmax23
Copy link
Collaborator

@gotmax23 gotmax23 commented Oct 5, 2023

This PR adds a clone-core nox session and applies the Python linters to the files in docs/bin.

@gotmax23 gotmax23 added backport-2.15 tooling This PR affects tooling (CI, pr_labeler, noxfile, linters, etc.) but not the docs builds themselves. labels Oct 5, 2023
@gotmax23 gotmax23 requested review from mattclay and oraNod October 5, 2023 22:13
@github-actions github-actions bot added the needs_triage Needs a first human triage before being processed. label Oct 5, 2023
oraNod
oraNod approved these changes Oct 6, 2023
View reviewed changes
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.

Looks perfect! Thanks @gotmax23

@oraNod oraNod removed the needs_triage Needs a first human triage before being processed. label Oct 6, 2023
@gotmax23 gotmax23 marked this pull request as draft October 9, 2023 20:26
@gotmax23 gotmax23 marked this pull request as ready for review October 10, 2023 19:37
@gotmax23
Copy link
Collaborator Author

gotmax23 commented Oct 10, 2023

I force pushed to split up the commits.

@gotmax23 gotmax23 mentioned this pull request Oct 10, 2023
Closed
@gotmax23 gotmax23 marked this pull request as draft October 10, 2023 20:11
@oraNod oraNod requested a review from nitzmahone October 11, 2023 08:54
@oraNod
Copy link
Contributor

oraNod commented Oct 11, 2023

@nitzmahone and @mattclay Hey! Could one of you please take a look as this modifies docs/bin? It'd be good to confirm the changes with someone from the core team. Thanks!

@oraNod
Copy link
Contributor

oraNod commented Oct 11, 2023

doh. I may have sent review requests a little prematurely given this is in draft state.

@gotmax23
Copy link
Collaborator Author

gotmax23 commented Oct 11, 2023

doh. I may have sent review requests a little prematurely given this is in draft state.

Nah, it should be ready for review :).

@mattclay
Copy link
Member

mattclay commented Oct 11, 2023

I'm not sure there's anything for me to review. The majority (all?) of the changes in docs/bin appear to be code formatting.

@mattclay mattclay removed their request for review October 11, 2023 19:17
@gotmax23 gotmax23 marked this pull request as ready for review October 11, 2023 22:32
@gotmax23
Copy link
Collaborator Author

gotmax23 commented Oct 11, 2023

I'm not sure there's anything for me to review. The majority (all?) of the changes in docs/bin appear to be code formatting.

The changes to those files are mostly reformatting and adding type annotations for mypy. I also removed python2-isms (from __future__ and metaclass boilerplate; dealing with text and bytes) from find-plugins-refs.py.

@gotmax23
add clone-core session to the noxfile
02ffb4d 
This adds a clone-core session to the noxfile that can be run with `nox
-e clone-core`.
The session is added to the default sessions in `nox.options.sessions`
so executing `nox` automatically clones core and runs all of the lint
sessions.
@gotmax23
include docs/bin/*.py in noxfile linting
320d1be 
This enforce the Python linters in the noxfile on the Python files in
docs/bin.
@gotmax23
run linters over docs/bin/*.py
8c2676f 
I ran the formatters and then fixed some line length and typing errors
manually.
@gotmax23
Copy link
Collaborator Author

gotmax23 commented Oct 11, 2023

I force pushed to fix a typo in a commit message. Other than that, I think this is good to merge.

@gotmax23 gotmax23 merged commit 881b326 into ansible:devel Oct 11, 2023
@patchback

This comment was marked as resolved.

Sign in to view
@patchback
Copy link

patchback bot commented Oct 11, 2023 •
edited
Loading

Backport to stable-2.16: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.16/881b3260c3defb7f18c461787d60ecb336154876/pr-529

Backported as #561

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Oct 11, 2023
@gotmax23 @patchback
Integrate docs/bin/*.py files into the nox config (#529)
e57c49f 
This PR adds a clone-core nox session and applies the Python linters to
the files in `docs/bin`.

(cherry picked from commit 881b326)
@patchback patchback bot mentioned this pull request Oct 11, 2023
Merged
gotmax23 added a commit to gotmax23/ansible-documentation that referenced this pull request Oct 11, 2023
@gotmax23
Integrate docs/bin/*.py files into the nox config (ansible#529)
1223b0c 
This PR adds a clone-core nox session and applies the Python linters to
the files in `docs/bin`.
gotmax23 added a commit to gotmax23/ansible-documentation that referenced this pull request Oct 11, 2023
@gotmax23
Integrate docs/bin/*.py files into the nox config (ansible#529)
bfaf49f 
This PR adds a clone-core nox session and applies the Python linters to
the files in `docs/bin`.

(cherry picked from commit 881b326)
@gotmax23
Copy link
Collaborator Author

gotmax23 commented Oct 11, 2023

Manual stable-2.15 backport: #562

@oraNod
Copy link
Contributor

oraNod commented Oct 12, 2023

I'm not sure there's anything for me to review. The majority (all?) of the changes in docs/bin appear to be code formatting.

@mattclay I wanted to make sure either yourself or @nitzmahone was aware of the changes as it touched code you've added. Just hoping to avoid future surprises really. Thanks for taking a look.

@oraNod
Copy link
Contributor

oraNod commented Oct 12, 2023

Thanks for adding this @gotmax23

gotmax23 added a commit that referenced this pull request Oct 12, 2023
@gotmax23
Integrate docs/bin/*.py files into the nox config (#529) (#562)
437c2dc 
This PR adds a clone-core nox session and applies the Python linters to
the files in `docs/bin`.

(cherry picked from commit 881b326)
gotmax23 added a commit that referenced this pull request Oct 12, 2023
@patchback @gotmax23
Integrate docs/bin/*.py files into the nox config (#529) (#561)
a5f5b02 
This PR adds a clone-core nox session and applies the Python linters to
the files in `docs/bin`.

(cherry picked from commit 881b326)

Co-authored-by: Maxwell G <maxwell@gtmx.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oraNod oraNod oraNod approved these changes

@nitzmahone nitzmahone Awaiting requested review from nitzmahone

Assignees

No one assigned

Labels

tooling This PR affects tooling (CI, pr_labeler, noxfile, linters, etc.) but not the docs builds themselves.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@gotmax23 @oraNod @mattclay